feat(PeriphDrivers): Add new ICC APIs (#1555)

Signed-off-by: Tahsin Mutlugun <Tahsin.Mutlugun@analog.com>

Author: ttmut

Libraries/PeriphDrivers/Include/MAX32520/icc.h

@@ -7,7 +7,7 @@
  *
  * Copyright (C) 2022-2023 Maxim Integrated Products, Inc. (now owned by 
  * Analog Devices, Inc.),
- * Copyright (C) 2023-2024 Analog Devices, Inc.
+ * Copyright (C) 2023-2026 Analog Devices, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -67,11 +67,27 @@ void MXC_ICC_Enable(void);
  */
 void MXC_ICC_Disable(void);
 
+/**
+ * @brief   Check if the instruction cache controller is enabled.
+ * @retval  Returns 1 if enabled, 0 if disabled.
+ */
+int MXC_ICC_IsEnabled(void);
+
 /**
  * @brief   Flush the instruction cache controller.
  */
 void MXC_ICC_Flush(void);
 
+/**
+ * @brief   Invalidate the instruction cache controller.
+ */
+void MXC_ICC_Invalidate(void);
+
+/**
+ * @brief   Wait until the instruction cache controller is ready.
+ */
+void MXC_ICC_WaitForReady(void);
+
 /**@} end of group icc */
 
 #ifdef __cplusplus

Libraries/PeriphDrivers/Include/MAX32570/icc.h

@@ -7,7 +7,7 @@
  *
  * Copyright (C) 2022-2023 Maxim Integrated Products, Inc. (now owned by 
  * Analog Devices, Inc.),
- * Copyright (C) 2023-2024 Analog Devices, Inc.
+ * Copyright (C) 2023-2026 Analog Devices, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -67,11 +67,27 @@ void MXC_ICC_Enable(void);
  */
 void MXC_ICC_Disable(void);
 
+/**
+ * @brief   Checks if the instruction cache controller is enabled.
+ * @retval  Returns 1 if the ICC instance is enabled, 0 otherwise.
+ */
+int MXC_ICC_IsEnabled(void);
+
 /**
  * @brief   Flush the instruction cache controller.
  */
 void MXC_ICC_Flush(void);
 
+/**
+ * @brief   Invalidate the instruction cache controller.
+ */
+void MXC_ICC_Invalidate(void);
+
+/**
+ * @brief   Wait until the instruction cache controller is ready.
+ */
+void MXC_ICC_WaitForReady(void);
+
 /**@} end of group icc */
 
 #ifdef __cplusplus

Libraries/PeriphDrivers/Include/MAX32650/icc.h

@@ -7,7 +7,7 @@
  *
  * Copyright (C) 2022-2023 Maxim Integrated Products, Inc. (now owned by 
  * Analog Devices, Inc.),
- * Copyright (C) 2023-2024 Analog Devices, Inc.
+ * Copyright (C) 2023-2026 Analog Devices, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -73,6 +73,11 @@ void MXC_ICC_Disable(void);
  */
 void MXC_ICC_Flush(void);
 
+/**
+ * @brief   Wait until both of the instruction cache controllers are ready.
+ */
+void MXC_ICC_WaitForReady(void);
+
 /**
  * @brief   Reads ID information from one of the ICC's Cache ID Register.
  * @param   icc     Pointer ICC instance to get ID information from.
@@ -93,12 +98,31 @@ void MXC_ICC_EnableInst(mxc_icc_regs_t *icc);
  */
 void MXC_ICC_DisableInst(mxc_icc_regs_t *icc);
 
+/**
+ * @brief   Checks if one of the ICC's is enabled.
+ * @param   icc     Pointer to ICC instance to check.
+ * @retval  Returns 1 if the ICC instance is enabled, 0 otherwise.
+ */
+int MXC_ICC_IsEnabledInst(mxc_icc_regs_t *icc);
+
 /**
  * @brief   Flushes data from one of the ICC's.
  * @param   icc     Pointer to ICC instance to flush.
  */
 void MXC_ICC_FlushInst(mxc_icc_regs_t *icc);
 
+/**
+ * @brief   Invalidates one of the ICC's.
+ * @param   icc     Pointer to ICC instance to invalidate.
+ */
+void MXC_ICC_InvalidateInst(mxc_icc_regs_t *icc);
+
+/**
+ * @brief   Wait until one of the instruction cache controller instances is ready.
+ * @param   icc     Pointer ICC instance to wait on.
+ */
+void MXC_ICC_WaitForReadyInst(mxc_icc_regs_t *icc);
+
 /**@} end of group icc */
 
 #ifdef __cplusplus

Libraries/PeriphDrivers/Include/MAX32655/icc.h

@@ -7,7 +7,7 @@
  *
  * Copyright (C) 2022-2023 Maxim Integrated Products, Inc. (now owned by 
  * Analog Devices, Inc.),
- * Copyright (C) 2023-2024 Analog Devices, Inc.
+ * Copyright (C) 2023-2026 Analog Devices, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -67,11 +67,29 @@ void MXC_ICC_Enable(mxc_icc_regs_t *icc);
  */
 void MXC_ICC_Disable(mxc_icc_regs_t *icc);
 
+/**
+ * @brief   Checks if the instruction cache controller is enabled.
+ * @param   icc     Pointer to ICC instance to check.
+ * @retval  Returns 1 if the ICC instance is enabled, 0 otherwise.
+ */
+int MXC_ICC_IsEnabled(mxc_icc_regs_t *icc);
+
 /**
  * @brief   Flush the instruction cache controller.
  */
 void MXC_ICC_Flush(mxc_icc_regs_t *icc);
 
+/**
+ * @brief   Invalidate the instruction cache controller.
+ */
+void MXC_ICC_Invalidate(mxc_icc_regs_t *icc);
+
+/**
+ * @brief   Wait until the instruction cache controller is ready.
+ * @param   icc Pointer to the Instruction Cache Controller registers.
+ */
+void MXC_ICC_WaitForReady(mxc_icc_regs_t *icc);
+
 /**@} end of group icc */
 
 #ifdef __cplusplus

Libraries/PeriphDrivers/Include/MAX32657/icc.h

@@ -5,7 +5,7 @@
 
 /******************************************************************************
  *
- * Copyright (C) 2024 Analog Devices, Inc.
+ * Copyright (C) 2024-2026 Analog Devices, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -65,11 +65,27 @@ void MXC_ICC_Enable(void);
  */
 void MXC_ICC_Disable(void);
 
+/**
+ * @brief   Checks if the instruction cache controller is enabled.
+ * @retval  Returns 1 if the ICC instance is enabled, 0 otherwise.
+ */
+int MXC_ICC_IsEnabled(void);
+
 /**
  * @brief   Flush the instruction cache controller.
  */
 void MXC_ICC_Flush(void);
 
+/**
+ * @brief   Invalidate the instruction cache controller.
+ */
+void MXC_ICC_Invalidate(void);
+
+/**
+ * @brief   Wait until the instruction cache controller is ready.
+ */
+void MXC_ICC_WaitForReady(void);
+
 /**@} end of group icc */
 
 #ifdef __cplusplus

Libraries/PeriphDrivers/Include/MAX32660/icc.h

@@ -7,7 +7,7 @@
  *
  * Copyright (C) 2022-2023 Maxim Integrated Products, Inc. (now owned by 
  * Analog Devices, Inc.),
- * Copyright (C) 2023-2024 Analog Devices, Inc.
+ * Copyright (C) 2023-2026 Analog Devices, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -67,11 +67,27 @@ void MXC_ICC_Enable(void);
  */
 void MXC_ICC_Disable(void);
 
+/**
+ * @brief   Checks if the instruction cache controller is enabled.
+ * @retval  Returns 1 if the ICC instance is enabled, 0 otherwise.
+ */
+int MXC_ICC_IsEnabled(void);
+
 /**
  * @brief   Flush the instruction cache controller.
  */
 void MXC_ICC_Flush(void);
 
+/**
+ * @brief   Invalidate the instruction cache controller.
+ */
+void MXC_ICC_Invalidate(void);
+
+/**
+ * @brief   Wait until the instruction cache controller is ready.
+ */
+void MXC_ICC_WaitForReady(void);
+
 /**@} end of group icc */
 
 #ifdef __cplusplus

Libraries/PeriphDrivers/Include/MAX32662/icc.h

@@ -7,7 +7,7 @@
  *
  * Copyright (C) 2022-2023 Maxim Integrated Products, Inc. (now owned by 
  * Analog Devices, Inc.),
- * Copyright (C) 2023-2024 Analog Devices, Inc.
+ * Copyright (C) 2023-2026 Analog Devices, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -67,11 +67,27 @@ void MXC_ICC_Enable(void);
  */
 void MXC_ICC_Disable(void);
 
+/**
+ * @brief   Checks if the instruction cache controller is enabled.
+ * @retval  Returns 1 if the ICC instance is enabled, 0 otherwise.
+ */
+int MXC_ICC_IsEnabled(void);
+
 /**
  * @brief   Flush the instruction cache controller.
  */
 void MXC_ICC_Flush(void);
 
+/**
+ * @brief   Invalidate the instruction cache controller.
+ */
+void MXC_ICC_Invalidate(void);
+
+/**
+ * @brief   Wait until the instruction cache controller is ready.
+ */
+void MXC_ICC_WaitForReady(void);
+
 /**@} end of group icc */
 
 #ifdef __cplusplus

Libraries/PeriphDrivers/Include/MAX32665/icc.h

@@ -7,7 +7,7 @@
  *
  * Copyright (C) 2022-2023 Maxim Integrated Products, Inc. (now owned by 
  * Analog Devices, Inc.),
- * Copyright (C) 2023-2024 Analog Devices, Inc.
+ * Copyright (C) 2023-2026 Analog Devices, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -92,12 +92,36 @@ void MXC_ICC_EnableInst(mxc_icc_regs_t *icc);
  */
 void MXC_ICC_DisableInst(mxc_icc_regs_t *icc);
 
+/**
+ * @brief   Checks if one of the ICC's is enabled.
+ * @param   icc     Pointer to ICC instance to check.
+ * @retval  Returns 1 if the ICC instance is enabled, 0 otherwise.
+ */
+int MXC_ICC_IsEnabledInst(mxc_icc_regs_t *icc);
+
 /**
  * @brief   Flushes data from one of the ICC's.
  * @param   icc     Pointer to ICC instance to flush.
  */
 void MXC_ICC_FlushInst(mxc_icc_regs_t *icc);
 
+/**
+ * @brief   Invalidates one of the ICC's.
+ * @param   icc     Pointer to ICC instance to invalidate.
+ */
+void MXC_ICC_InvalidateInst(mxc_icc_regs_t *icc);
+
+/**
+ * @brief   Wait until both the instruction cache controller and/or instance are ready.
+ */
+void MXC_ICC_WaitForReady(void);
+
+/**
+ * @brief   Wait until the instruction cache controller instance is ready.
+ * @param   icc     Pointer to ICC instance to wait on.
+ */
+void MXC_ICC_WaitForReadyInst(mxc_icc_regs_t *icc);
+
 /**@} end of group icc */
 
 #ifdef __cplusplus

Libraries/PeriphDrivers/Include/MAX32670/icc.h

@@ -7,7 +7,7 @@
  *
  * Copyright (C) 2022-2023 Maxim Integrated Products, Inc. (now owned by 
  * Analog Devices, Inc.),
- * Copyright (C) 2023-2024 Analog Devices, Inc.
+ * Copyright (C) 2023-2026 Analog Devices, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -67,11 +67,27 @@ void MXC_ICC_Enable(void);
  */
 void MXC_ICC_Disable(void);
 
+/**
+ * @brief   Checks if the instruction cache controller is enabled.
+ * @retval  Returns 1 if the ICC instance is enabled, 0 otherwise.
+ */
+int MXC_ICC_IsEnabled(void);
+
 /**
  * @brief   Flush the instruction cache controller.
  */
 void MXC_ICC_Flush(void);
 
+/**
+ * @brief   Invalidate the instruction cache controller.
+ */
+void MXC_ICC_Invalidate(void);
+
+/**
+ * @brief   Wait until the instruction cache controller is ready.
+ */
+void MXC_ICC_WaitForReady(void);
+
 /**@} end of group icc */
 
 #ifdef __cplusplus

Libraries/PeriphDrivers/Include/MAX32672/icc.h

@@ -7,7 +7,7 @@
  *
  * Copyright (C) 2022-2023 Maxim Integrated Products, Inc. (now owned by 
  * Analog Devices, Inc.),
- * Copyright (C) 2023-2024 Analog Devices, Inc.
+ * Copyright (C) 2023-2026 Analog Devices, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -67,11 +67,27 @@ void MXC_ICC_Enable(void);
  */
 void MXC_ICC_Disable(void);
 
+/**
+ * @brief   Checks if the instruction cache controller is enabled.
+ * @retval  Returns 1 if the ICC instance is enabled, 0 otherwise.
+ */
+int MXC_ICC_IsEnabled(void);
+
 /**
  * @brief   Flush the instruction cache controller.
  */
 void MXC_ICC_Flush(void);
 
+/**
+ * @brief   Invalidate the instruction cache controller.
+ */
+void MXC_ICC_Invalidate(void);
+
+/**
+ * @brief   Wait until the instruction cache controller is ready.
+ */
+void MXC_ICC_WaitForReady(void);
+
 /**@} end of group icc */
 
 #ifdef __cplusplus