blob: f3f3a23725287201131001c09744de98333cd3be [file] [log] [blame]
/*
* Utility routines for configuring different memories in Broadcom chips.
*
* Copyright (C) 1999-2019, Broadcom.
*
* Unless you and Broadcom execute a separate written software license
* agreement governing use of this software, this software is licensed to you
* under the terms of the GNU General Public License version 2 (the "GPL"),
* available at http://www.broadcom.com/licenses/GPLv2.php, with the
* following added to such license:
*
* As a special exception, the copyright holders of this software give you
* permission to link this software with independent modules, and to copy and
* distribute the resulting executable under terms of your choice, provided that
* you also meet, for each linked independent module, the terms and conditions of
* the license of that module. An independent module is a module which is not
* derived from this software. The special exception does not apply to any
* modifications of the software.
*
* Notwithstanding the above, under no circumstances may you combine this
* software in any way with any other Broadcom software provided under a license
* other than the GPL, without Broadcom's express prior written consent.
*
*
* <<Broadcom-WL-IPTag/Open:>>
*
* $Id: $
*/
#ifndef _HNDMEM_H_
#define _HNDMEM_H_
typedef enum {
MEM_SOCRAM = 0,
MEM_BM = 1,
MEM_UCM = 2,
MEM_SHM = 3,
MEM_MAX = 4
} hndmem_type_t;
/* PDA (Power Down Array) configuration */
typedef enum {
PDA_CONFIG_CLEAR = 0, /* Clear PDA, i.e. Turns on the memory bank */
PDA_CONFIG_SET_FULL = 1, /* Set PDA, i.e. Truns off the memory bank */
PDA_CONFIG_SET_PARTIAL = 2, /* Set PDA, i.e. Truns off the memory bank */
PDA_CONFIG_MAX = 3
} hndmem_config_t;
/* Returns the number of banks in a given memory */
extern int hndmem_num_banks(si_t *sih, int mem);
/* Returns the size of a give bank in a given memory */
extern int hndmem_bank_size(si_t *sih, hndmem_type_t mem, int bank_num);
/* Returns the start address of given memory */
extern uint32 hndmem_mem_base(si_t *sih, hndmem_type_t mem);
#ifdef BCMDEBUG
/* Dumps the complete memory information */
extern void hndmem_dump_meminfo_all(si_t *sih);
#endif /* BCMDEBUG */
/* Configures the Sleep PDA for a particular bank for a given memory type */
extern int hndmem_sleeppda_bank_config(si_t *sih, hndmem_type_t mem,
int bank_num, hndmem_config_t config, uint32 pda);
/* Configures the Active PDA for a particular bank for a given memory type */
extern int hndmem_activepda_bank_config(si_t *sih, hndmem_type_t mem,
int bank_num, hndmem_config_t config, uint32 pda);
/* Configures the Sleep PDA for all the banks for a given memory type */
extern int hndmem_sleeppda_config(si_t *sih, hndmem_type_t mem,
hndmem_config_t config);
/* Configures the Active PDA for all the banks for a given memory type */
extern int hndmem_activepda_config(si_t *sih, hndmem_type_t mem,
hndmem_config_t config);
/* Turn off/on all the possible banks in a given memory range */
extern int hndmem_activepda_mem_config(si_t *sih, hndmem_type_t mem,
uint32 mem_start, uint32 size, hndmem_config_t config);
#endif /* _HNDMEM_H_ */