refactor(PeriphDrivers): Mark some HPB parameters as const

To support the upcoming Zephyr HPB driver work, mark some HPB functions parameters as const, where appropriate. Signed-off-by: Pete Johanson <[email protected]>
analogdevicesinc · Mar 7, 2025 · 54663b6 · 54663b6
1 parent 2ec3f4e
commit 54663b6
Show file tree

Hide file tree

Showing 6 changed files with 30 additions and 22 deletions.
diff --git a/Libraries/PeriphDrivers/Include/MAX32650/hpb.h b/Libraries/PeriphDrivers/Include/MAX32650/hpb.h
@@ -124,7 +124,7 @@ typedef struct {
     mxc_hpb_device_t device_type;
 
     /** Pointer to array of address offset/value pairs */
-    mxc_hpb_cfg_reg_val_t *cfg_reg_val;
+    const mxc_hpb_cfg_reg_val_t *cfg_reg_val;
 
     /** number of configuration pairs */
     unsigned int cfg_reg_val_len;
@@ -174,7 +174,8 @@ void MXC_HPB_RegRead8(mxc_hpb_cfg_reg_val_t *cfg_reg_val, uint32_t base_addr, un
  * @param base_addr    Base address
  * @param index        0 or 1 to determine which configuration settings    
 */
-void MXC_HPB_RegWrite8(mxc_hpb_cfg_reg_val_t *cfg_reg_val, uint32_t base_addr, unsigned int index);
+void MXC_HPB_RegWrite8(const mxc_hpb_cfg_reg_val_t *cfg_reg_val, uint32_t base_addr,
+                       unsigned int index);
 
 /**
  * @brief Read a variable
@@ -190,7 +191,8 @@ void MXC_HPB_RegRead16(mxc_hpb_cfg_reg_val_t *cfg_reg_val, uint32_t base_addr, u
  * @param base_addr    Base address
  * @param index        0 or 1 to determine which configuration settings    
 */
-void MXC_HPB_RegWrite16(mxc_hpb_cfg_reg_val_t *cfg_reg_val, uint32_t base_addr, unsigned int index);
+void MXC_HPB_RegWrite16(const mxc_hpb_cfg_reg_val_t *cfg_reg_val, uint32_t base_addr,
+                        unsigned int index);
 
 /**
  * @brief Configure the HyperBus peripheral.

diff --git a/Libraries/PeriphDrivers/Include/MAX32690/hpb.h b/Libraries/PeriphDrivers/Include/MAX32690/hpb.h
@@ -124,7 +124,7 @@ typedef struct {
     mxc_hpb_device_t device_type;
 
     /** Pointer to array of address offset/value pairs */
-    mxc_hpb_cfg_reg_val_t *cfg_reg_val;
+    const mxc_hpb_cfg_reg_val_t *cfg_reg_val;
 
     /** number of configuration pairs */
     unsigned int cfg_reg_val_len;
@@ -174,7 +174,8 @@ void MXC_HPB_RegRead8(mxc_hpb_cfg_reg_val_t *cfg_reg_val, uint32_t base_addr, un
  * @param base_addr    Base address
  * @param index        0 or 1 to determine which configuration settings    
 */
-void MXC_HPB_RegWrite8(mxc_hpb_cfg_reg_val_t *cfg_reg_val, uint32_t base_addr, unsigned int index);
+void MXC_HPB_RegWrite8(const mxc_hpb_cfg_reg_val_t *cfg_reg_val, uint32_t base_addr,
+                       unsigned int index);
 
 /**
  * @brief Read a variable
@@ -190,7 +191,8 @@ void MXC_HPB_RegRead16(mxc_hpb_cfg_reg_val_t *cfg_reg_val, uint32_t base_addr, u
  * @param base_addr    Base address
  * @param index        0 or 1 to determine which configuration settings    
 */
-void MXC_HPB_RegWrite16(mxc_hpb_cfg_reg_val_t *cfg_reg_val, uint32_t base_addr, unsigned int index);
+void MXC_HPB_RegWrite16(const mxc_hpb_cfg_reg_val_t *cfg_reg_val, uint32_t base_addr,
+                        unsigned int index);
 
 /**
  * @brief Configure the HyperBus peripheral.
@@ -200,7 +202,7 @@ void MXC_HPB_RegWrite16(mxc_hpb_cfg_reg_val_t *cfg_reg_val, uint32_t base_addr,
  *             this memory not used)
  * @return #E_BAD_PARAM if configuration error, #E_NO_ERROR otherwise
  */
-int MXC_HPB_Init(mxc_hpb_mem_config_t *mem0, mxc_hpb_mem_config_t *mem1);
+int MXC_HPB_Init(const mxc_hpb_mem_config_t *mem0, const mxc_hpb_mem_config_t *mem1);
 
 /**
  * @brief   Returns the contents of the status register.

diff --git a/Libraries/PeriphDrivers/Source/HPB/hpb_me10.c b/Libraries/PeriphDrivers/Source/HPB/hpb_me10.c
@@ -41,7 +41,8 @@ void MXC_HPB_RegRead8(mxc_hpb_cfg_reg_val_t *cfg_reg_val, uint32_t base_addr, un
 }
 
 /* ************************************************************************** */
-void MXC_HPB_RegWrite8(mxc_hpb_cfg_reg_val_t *cfg_reg_val, uint32_t base_addr, unsigned int index)
+void MXC_HPB_RegWrite8(const mxc_hpb_cfg_reg_val_t *cfg_reg_val, uint32_t base_addr,
+                       unsigned int index)
 {
     MXC_HPB_RevA_RegWrite8((mxc_hpb_reva_regs_t *)MXC_HPB, cfg_reg_val, base_addr, index);
 }
@@ -53,13 +54,14 @@ void MXC_HPB_RegRead16(mxc_hpb_cfg_reg_val_t *cfg_reg_val, uint32_t base_addr, u
 }
 
 /* ************************************************************************** */
-void MXC_HPB_RegWrite16(mxc_hpb_cfg_reg_val_t *cfg_reg_val, uint32_t base_addr, unsigned int index)
+void MXC_HPB_RegWrite16(const mxc_hpb_cfg_reg_val_t *cfg_reg_val, uint32_t base_addr,
+                        unsigned int index)
 {
     MXC_HPB_RevA_RegWrite16((mxc_hpb_reva_regs_t *)MXC_HPB, cfg_reg_val, base_addr, index);
 }
 
 /* ************************************************************************** */
-int MXC_HPB_Init(mxc_hpb_mem_config_t *mem0, mxc_hpb_mem_config_t *mem1)
+int MXC_HPB_Init(const mxc_hpb_mem_config_t *mem0, const mxc_hpb_mem_config_t *mem1)
 {
     /* Enable HyperBus Clocks */
     MXC_SYS_ClockEnable(MXC_SYS_PERIPH_CLOCK_HBC);

diff --git a/Libraries/PeriphDrivers/Source/HPB/hpb_me18.c b/Libraries/PeriphDrivers/Source/HPB/hpb_me18.c
@@ -41,7 +41,8 @@ void MXC_HPB_RegRead8(mxc_hpb_cfg_reg_val_t *cfg_reg_val, uint32_t base_addr, un
 }
 
 /* ************************************************************************** */
-void MXC_HPB_RegWrite8(mxc_hpb_cfg_reg_val_t *cfg_reg_val, uint32_t base_addr, unsigned int index)
+void MXC_HPB_RegWrite8(const mxc_hpb_cfg_reg_val_t *cfg_reg_val, uint32_t base_addr,
+                       unsigned int index)
 {
     MXC_HPB_RevA_RegWrite8((mxc_hpb_reva_regs_t *)MXC_HPB, cfg_reg_val, base_addr, index);
 }
@@ -53,13 +54,14 @@ void MXC_HPB_RegRead16(mxc_hpb_cfg_reg_val_t *cfg_reg_val, uint32_t base_addr, u
 }
 
 /* ************************************************************************** */
-void MXC_HPB_RegWrite16(mxc_hpb_cfg_reg_val_t *cfg_reg_val, uint32_t base_addr, unsigned int index)
+void MXC_HPB_RegWrite16(const mxc_hpb_cfg_reg_val_t *cfg_reg_val, uint32_t base_addr,
+                        unsigned int index)
 {
     MXC_HPB_RevA_RegWrite16((mxc_hpb_reva_regs_t *)MXC_HPB, cfg_reg_val, base_addr, index);
 }
 
 /* ************************************************************************** */
-int MXC_HPB_Init(mxc_hpb_mem_config_t *mem0, mxc_hpb_mem_config_t *mem1)
+int MXC_HPB_Init(const mxc_hpb_mem_config_t *mem0, const mxc_hpb_mem_config_t *mem1)
 {
     /* Enable HyperBus Clocks */
     MXC_SYS_ClockEnable(MXC_SYS_PERIPH_CLOCK_HPB);

diff --git a/Libraries/PeriphDrivers/Source/HPB/hpb_reva.c b/Libraries/PeriphDrivers/Source/HPB/hpb_reva.c
@@ -34,7 +34,7 @@
 /* **** Functions **** */
 
 /* ************************************************************************** */
-static void MXC_HPB_RevA_ConfigMem(mxc_hpb_reva_regs_t *hpb, mxc_hpb_mem_config_t *mem,
+static void MXC_HPB_RevA_ConfigMem(mxc_hpb_reva_regs_t *hpb, const mxc_hpb_mem_config_t *mem,
                                    unsigned index)
 {
     int i;
@@ -81,7 +81,7 @@ void MXC_HPB_RevA_RegRead8(mxc_hpb_reva_regs_t *hpb, mxc_hpb_cfg_reg_val_t *cfg_
 }
 
 /* ************************************************************************** */
-void MXC_HPB_RevA_RegWrite8(mxc_hpb_reva_regs_t *hpb, mxc_hpb_cfg_reg_val_t *cfg_reg_val,
+void MXC_HPB_RevA_RegWrite8(mxc_hpb_reva_regs_t *hpb, const mxc_hpb_cfg_reg_val_t *cfg_reg_val,
                             uint32_t base_addr, unsigned int index)
 {
     if (!hpb || !cfg_reg_val || index > 1) {
@@ -111,7 +111,7 @@ void MXC_HPB_RevA_RegRead16(mxc_hpb_reva_regs_t *hpb, mxc_hpb_cfg_reg_val_t *cfg
 }
 
 /* ************************************************************************** */
-void MXC_HPB_RevA_RegWrite16(mxc_hpb_reva_regs_t *hpb, mxc_hpb_cfg_reg_val_t *cfg_reg_val,
+void MXC_HPB_RevA_RegWrite16(mxc_hpb_reva_regs_t *hpb, const mxc_hpb_cfg_reg_val_t *cfg_reg_val,
                              uint32_t base_addr, unsigned int index)
 {
     if (!hpb || !cfg_reg_val || index > 1) {
@@ -126,8 +126,8 @@ void MXC_HPB_RevA_RegWrite16(mxc_hpb_reva_regs_t *hpb, mxc_hpb_cfg_reg_val_t *cf
 }
 
 /* ************************************************************************** */
-int MXC_HPB_RevA_Init(mxc_hpb_reva_regs_t *hpb, mxc_hpb_mem_config_t *mem0,
-                      mxc_hpb_mem_config_t *mem1)
+int MXC_HPB_RevA_Init(mxc_hpb_reva_regs_t *hpb, const mxc_hpb_mem_config_t *mem0,
+                      const mxc_hpb_mem_config_t *mem1)
 {
     if (mem0) {
         MXC_HPB_RevA_ConfigMem(hpb, mem0, 0);

diff --git a/Libraries/PeriphDrivers/Source/HPB/hpb_reva.h b/Libraries/PeriphDrivers/Source/HPB/hpb_reva.h
@@ -46,14 +46,14 @@ typedef enum {
 /* **** Function Prototypes **** */
 void MXC_HPB_RevA_RegRead8(mxc_hpb_reva_regs_t *hpb, mxc_hpb_cfg_reg_val_t *cfg_reg_val,
                            uint32_t base_addr, unsigned int index);
-void MXC_HPB_RevA_RegWrite8(mxc_hpb_reva_regs_t *hpb, mxc_hpb_cfg_reg_val_t *cfg_reg_val,
+void MXC_HPB_RevA_RegWrite8(mxc_hpb_reva_regs_t *hpb, const mxc_hpb_cfg_reg_val_t *cfg_reg_val,
                             uint32_t base_addr, unsigned int index);
 void MXC_HPB_RevA_RegRead16(mxc_hpb_reva_regs_t *hpb, mxc_hpb_cfg_reg_val_t *cfg_reg_val,
                             uint32_t base_addr, unsigned int index);
-void MXC_HPB_RevA_RegWrite16(mxc_hpb_reva_regs_t *hpb, mxc_hpb_cfg_reg_val_t *cfg_reg_val,
+void MXC_HPB_RevA_RegWrite16(mxc_hpb_reva_regs_t *hpb, const mxc_hpb_cfg_reg_val_t *cfg_reg_val,
                              uint32_t base_addr, unsigned int index);
-int MXC_HPB_RevA_Init(mxc_hpb_reva_regs_t *hpb, mxc_hpb_mem_config_t *mem0,
-                      mxc_hpb_mem_config_t *mem1);
+int MXC_HPB_RevA_Init(mxc_hpb_reva_regs_t *hpb, const mxc_hpb_mem_config_t *mem0,
+                      const mxc_hpb_mem_config_t *mem1);
 uint32_t MXC_HPB_RevA_GetStatus(mxc_hpb_reva_regs_t *hpb);
 void MXC_HPB_RevA_EnableInt(mxc_hpb_reva_regs_t *hpb, unsigned polarity);
 unsigned MXC_HPB_RevA_GetFlag(mxc_hpb_reva_regs_t *hpb);