1 /* 2 * Utility routines for configuring different memories in Broadcom chips. 3 * 4 * Copyright (C) 2020, Broadcom. 5 * 6 * Unless you and Broadcom execute a separate written software license 7 * agreement governing use of this software, this software is licensed to you 8 * under the terms of the GNU General Public License version 2 (the "GPL"), 9 * available at http://www.broadcom.com/licenses/GPLv2.php, with the 10 * following added to such license: 11 * 12 * As a special exception, the copyright holders of this software give you 13 * permission to link this software with independent modules, and to copy and 14 * distribute the resulting executable under terms of your choice, provided that 15 * you also meet, for each linked independent module, the terms and conditions of 16 * the license of that module. An independent module is a module which is not 17 * derived from this software. The special exception does not apply to any 18 * modifications of the software. 19 * 20 * 21 * <<Broadcom-WL-IPTag/Dual:>> 22 */ 23 24 #ifndef _HNDMEM_H_ 25 #define _HNDMEM_H_ 26 27 typedef enum { 28 MEM_SOCRAM = 0, 29 MEM_BM = 1, 30 MEM_UCM = 2, 31 MEM_SHM = 3, 32 MEM_MAX = 4 33 } hndmem_type_t; 34 35 /* PDA (Power Down Array) configuration */ 36 typedef enum { 37 PDA_CONFIG_CLEAR = 0, /* Clear PDA, i.e. Turns on the memory bank */ 38 PDA_CONFIG_SET_FULL = 1, /* Set PDA, i.e. Truns off the memory bank */ 39 PDA_CONFIG_SET_PARTIAL = 2, /* Set PDA, i.e. Truns off the memory bank */ 40 PDA_CONFIG_MAX = 3 41 } hndmem_config_t; 42 43 /* Returns the number of banks in a given memory */ 44 extern int hndmem_num_banks(si_t *sih, int mem); 45 46 /* Returns the size of a give bank in a given memory */ 47 extern int hndmem_bank_size(si_t *sih, hndmem_type_t mem, int bank_num); 48 49 /* Returns the start address of given memory */ 50 extern uint32 hndmem_mem_base(si_t *sih, hndmem_type_t mem); 51 52 #ifdef BCMDEBUG 53 /* Dumps the complete memory information */ 54 extern void hndmem_dump_meminfo_all(si_t *sih); 55 #endif /* BCMDEBUG */ 56 57 /* Configures the Sleep PDA for a particular bank for a given memory type */ 58 extern int hndmem_sleeppda_bank_config(si_t *sih, hndmem_type_t mem, 59 int bank_num, hndmem_config_t config, uint32 pda); 60 /* Configures the Active PDA for a particular bank for a given memory type */ 61 extern int hndmem_activepda_bank_config(si_t *sih, hndmem_type_t mem, 62 int bank_num, hndmem_config_t config, uint32 pda); 63 64 /* Configures the Sleep PDA for all the banks for a given memory type */ 65 extern int hndmem_sleeppda_config(si_t *sih, hndmem_type_t mem, 66 hndmem_config_t config); 67 /* Configures the Active PDA for all the banks for a given memory type */ 68 extern int hndmem_activepda_config(si_t *sih, hndmem_type_t mem, 69 hndmem_config_t config); 70 71 /* Turn off/on all the possible banks in a given memory range */ 72 extern int hndmem_activepda_mem_config(si_t *sih, hndmem_type_t mem, 73 uint32 mem_start, uint32 size, hndmem_config_t config); 74 #endif /* _HNDMEM_H_ */ 75