hndmem.h 3.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182
  1. /*
  2. * Utility routines for configuring different memories in Broadcom chips.
  3. *
  4. * Portions of this code are copyright (c) 2020 Cypress Semiconductor Corporation
  5. *
  6. * Copyright (C) 1999-2020, 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. #ifndef _HNDMEM_H_
  32. #define _HNDMEM_H_
  33. typedef enum {
  34. MEM_SOCRAM = 0,
  35. MEM_BM = 1,
  36. MEM_UCM = 2,
  37. MEM_SHM = 3,
  38. MEM_MAX = 4
  39. } hndmem_type_t;
  40. /* PDA (Power Down Array) configuration */
  41. typedef enum {
  42. PDA_CONFIG_CLEAR = 0, /* Clear PDA, i.e. Turns on the memory bank */
  43. PDA_CONFIG_SET_FULL = 1, /* Set PDA, i.e. Truns off the memory bank */
  44. PDA_CONFIG_SET_PARTIAL = 2, /* Set PDA, i.e. Truns off the memory bank */
  45. PDA_CONFIG_MAX = 3
  46. } hndmem_config_t;
  47. /* Returns the number of banks in a given memory */
  48. extern int hndmem_num_banks(si_t *sih, int mem);
  49. /* Returns the size of a give bank in a given memory */
  50. extern int hndmem_bank_size(si_t *sih, hndmem_type_t mem, int bank_num);
  51. /* Returns the start address of given memory */
  52. extern uint32 hndmem_mem_base(si_t *sih, hndmem_type_t mem);
  53. #ifdef BCMDEBUG
  54. /* Dumps the complete memory information */
  55. extern void hndmem_dump_meminfo_all(si_t *sih);
  56. #endif /* BCMDEBUG */
  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. /* Configures the Sleep PDA for all the banks for a given memory type */
  64. extern int hndmem_sleeppda_config(si_t *sih, hndmem_type_t mem,
  65. hndmem_config_t config);
  66. /* Configures the Active PDA for all the banks for a given memory type */
  67. extern int hndmem_activepda_config(si_t *sih, hndmem_type_t mem,
  68. hndmem_config_t config);
  69. /* Turn off/on all the possible banks in a given memory range */
  70. extern int hndmem_activepda_mem_config(si_t *sih, hndmem_type_t mem,
  71. uint32 mem_start, uint32 size, hndmem_config_t config);
  72. #endif /* _HNDMEM_H_ */