Apply consistent system return code to adi_system_EnableRetention()

Edmund Hsu · Edmund Hsu · commit b57f90241e39 · 2018-08-29T13:42:16.000+10:00
diff --git a/targets/TARGET_Analog_Devices/TARGET_ADUCM302X/TARGET_ADUCM3029/TARGET_EV_COG_AD3029LZ/device/system_ADuCM3029.c b/targets/TARGET_Analog_Devices/TARGET_ADUCM302X/TARGET_ADUCM3029/TARGET_EV_COG_AD3029LZ/device/system_ADuCM3029.c
@@ -259,8 +259,8 @@ void adi_system_EnableISRAM(bool bEnable)
  * \n
  * \n              false :To disable retention during the hibernation.
  * \n
- * @return : SUCCESS : Configured successfully.
- *           FAILURE :  For invalid bank.
+ * @return : ADI_SYS_SUCCESS : Configured successfully.
+ *           ADI_SYS_FAILURE :  For invalid bank.
  * @note: Please note that respective linker file need to support the configuration. Only BANK-1 and
           BANK-2 of SRAM is valid.
  */
@@ -269,7 +269,7 @@ uint32_t adi_system_EnableRetention(ADI_SRAM_BANK eBank,bool bEnable)
 #ifdef ADI_DEBUG
     if((eBank != ADI_SRAM_BANK_1) && (eBank != ADI_SRAM_BANK_2))
     {
-        return FAILURE;
+        return ADI_SYS_FAILURE;
     }
 #endif
     pADI_PMG0->PWRKEY = PWRKEY_VALUE_KEY;
@@ -282,5 +282,5 @@ uint32_t adi_system_EnableRetention(ADI_SRAM_BANK eBank,bool bEnable)
         pADI_PMG0->SRAMRET &= ~((uint32_t)eBank >> 1);
     }
 
-    return SUCCESS;
+    return ADI_SYS_SUCCESS;
 }

Original file line number	Diff line number	Diff line change
`@@ -259,8 +259,8 @@ void adi_system_EnableISRAM(bool bEnable)`
`259`	`259`	`* \n`
`260`	`260`	`* \n false :To disable retention during the hibernation.`
`261`	`261`	`* \n`
`262`		`- * @return : SUCCESS : Configured successfully.`
`263`		`- * FAILURE : For invalid bank.`
	`262`	`+ * @return : ADI_SYS_SUCCESS : Configured successfully.`
	`263`	`+ * ADI_SYS_FAILURE : For invalid bank.`
`264`	`264`	`* @note: Please note that respective linker file need to support the configuration. Only BANK-1 and`
`265`	`265`	`BANK-2 of SRAM is valid.`
`266`	`266`	`*/`
`@@ -269,7 +269,7 @@ uint32_t adi_system_EnableRetention(ADI_SRAM_BANK eBank,bool bEnable)`
`269`	`269`	`#ifdef ADI_DEBUG`
`270`	`270`	`if((eBank != ADI_SRAM_BANK_1) && (eBank != ADI_SRAM_BANK_2))`
`271`	`271`	`{`
`272`		`- return FAILURE;`
	`272`	`+ return ADI_SYS_FAILURE;`
`273`	`273`	`}`
`274`	`274`	`#endif`
`275`	`275`	`pADI_PMG0->PWRKEY = PWRKEY_VALUE_KEY;`
`@@ -282,5 +282,5 @@ uint32_t adi_system_EnableRetention(ADI_SRAM_BANK eBank,bool bEnable)`
`282`	`282`	`pADI_PMG0->SRAMRET &= ~((uint32_t)eBank >> 1);`
`283`	`283`	`}`
`284`	`284`
`285`		`- return SUCCESS;`
	`285`	`+ return ADI_SYS_SUCCESS;`
`286`	`286`	`}`