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