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