]> Gitweb @ Texas Instruments - Open Source Git Repositories - git.TI.com/gitweb - keystone-rtos/edma3_lld.git/blobdiff - packages/ti/sdo/edma3/rm/edma3_common.h
Misra C fixes:
[keystone-rtos/edma3_lld.git] / packages / ti / sdo / edma3 / rm / edma3_common.h
index d8d5164845e0154496f7da7915ae33e096e5c255..abddc147a7e6ac727b4d6b9c6deda179f796a8bd 100755 (executable)
  *
 */
 
-#ifndef _EDMA3_COMMON_H_
-#define _EDMA3_COMMON_H_
+#ifndef EDMA3_COMMON_H_
+#define EDMA3_COMMON_H_
+
+/***************************************************************\
+* Standard Definition Header File For Null Definition *
+\***************************************************************/
+#include <stddef.h>
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
 /** define to enable/disable Resource Manager debug messages*/
-#define EDMA3_RM_DEBUG
-#undef EDMA3_RM_DEBUG
+/* #define EDMA3_RM_DEBUG */
 
 /** define to enable/disable EDMA3 Driver debug messages*/
-#define EDMA3_DRV_DEBUG
-#undef EDMA3_DRV_DEBUG
+/* #define EDMA3_DRV_DEBUG */
 
 /** Debug mechanism used for Resource Manager */
 #ifdef EDMA3_RM_DEBUG
@@ -66,25 +69,22 @@ extern "C" {
 /** Defines for boolean variables */
 #ifndef TRUE
   /** TRUE */
-  #define TRUE  (1u)
+  #define TRUE  (1U)
   /** FALSE */
-  #define FALSE (0u)
-#endif
-
-/** Define for NULL values*/
-#ifndef NULL
-#define NULL 0u
+  #define FALSE (0U)
 #endif
 
 /** EDMA3_RM Result - return value of a function  */
 typedef int32_t             EDMA3_RM_Result;
 /** EDMA3_DRV Result - return value of a function  */
 typedef int32_t             EDMA3_DRV_Result;
+/** EDMA3_Result - return value of a function for common functions of DRV and RM */
+typedef int32_t             EDMA3_Result;
 
 /** EDMA3 Resource Manager Result OK */
-#define EDMA3_RM_SOK             (0u)
+#define EDMA3_RM_SOK             (0)
 /** EDMA3 Driver Result OK */
-#define EDMA3_DRV_SOK            (0u)
+#define EDMA3_DRV_SOK            (0)
 
 /**
  * EDMA3 Resource Manager Handle.
@@ -116,49 +116,49 @@ typedef void    *EDMA3_OS_Sem_Handle;
  * Manager.
  */
 /** Maximum EDMA3 Controllers on the SoC */
-#define EDMA3_MAX_EDMA3_INSTANCES               (3u)
+#define EDMA3_MAX_EDMA3_INSTANCES               (5U)
 /** Maximum DMA channels supported by the EDMA3 Controller */
-#define EDMA3_MAX_DMA_CH                        (64u)
+#define EDMA3_MAX_DMA_CH                        (64U)
 /** Maximum QDMA channels supported by the EDMA3 Controller */
-#define EDMA3_MAX_QDMA_CH                       (8u)
+#define EDMA3_MAX_QDMA_CH                       (8U)
 /** Maximum PaRAM Sets supported by the EDMA3 Controller */
-#define EDMA3_MAX_PARAM_SETS                    (512u)
+#define EDMA3_MAX_PARAM_SETS                    (512U)
 /** Maximum Logical channels supported by the EDMA3 Package */
 #define EDMA3_MAX_LOGICAL_CH                    (EDMA3_MAX_DMA_CH + \
                                                  EDMA3_MAX_PARAM_SETS + \
                                                  EDMA3_MAX_QDMA_CH)
 /** Maximum TCCs (Interrupt Channels) supported by the EDMA3 Controller */
-#define EDMA3_MAX_TCC                           (64u)
+#define EDMA3_MAX_TCC                           (64U)
 /** Maximum Event Queues supported by the EDMA3 Controller */
-#define EDMA3_MAX_EVT_QUE                       (8u)
+#define EDMA3_MAX_EVT_QUE                       (8U)
 /** Maximum Transfer Controllers supported by the EDMA3 Controller */
-#define EDMA3_MAX_TC                            (8u)
+#define EDMA3_MAX_TC                            (8U)
 /** Maximum Shadow Regions supported by the EDMA3 Controller */
-#define EDMA3_MAX_REGIONS                       (8u)
+#define EDMA3_MAX_REGIONS                       (8U)
 
 /**
  * Maximum Words (4-bytes region) required for the book-keeping information
  * specific to the maximum possible DMA channels.
  */
-#define EDMA3_MAX_DMA_CHAN_DWRDS                (EDMA3_MAX_DMA_CH / 32u)
+#define EDMA3_MAX_DMA_CHAN_DWRDS                (EDMA3_MAX_DMA_CH / 32U)
 
 /**
  * Maximum Words (4-bytes region) required for the book-keeping information
  * specific to the maximum possible QDMA channels.
  */
-#define EDMA3_MAX_QDMA_CHAN_DWRDS               (1u)
+#define EDMA3_MAX_QDMA_CHAN_DWRDS               (1U)
 
 /**
  * Maximum Words (4-bytes region) required for the book-keeping information
  * specific to the maximum possible PaRAM Sets.
  */
-#define EDMA3_MAX_PARAM_DWRDS                   (EDMA3_MAX_PARAM_SETS / 32u)
+#define EDMA3_MAX_PARAM_DWRDS                   (EDMA3_MAX_PARAM_SETS / 32U)
 
 /**
  * Maximum Words (4-bytes region) required for the book-keeping information
  * specific to the maximum possible TCCs.
  */
-#define EDMA3_MAX_TCC_DWRDS                     (EDMA3_MAX_TCC / 32u)
+#define EDMA3_MAX_TCC_DWRDS                     (EDMA3_MAX_TCC / 32U)
 
 /**
  * EDMA3 ISRs which need to be registered with the underlying OS by the user
@@ -166,27 +166,27 @@ typedef void    *EDMA3_OS_Sem_Handle;
  * available Transfer Controllers).
  */
 /**  EDMA3 Completion Handler ISR Routine */
-extern void lisrEdma3ComplHandler0 (uint32_t arg);
+extern void lisrEdma3ComplHandler0 (uint32_t edma3InstanceId);
 
 /**  EDMA3 CC Error Interrupt Handler ISR Routine */
-extern void lisrEdma3CCErrHandler0 (uint32_t arg);
+extern void lisrEdma3CCErrHandler0 (uint32_t edma3InstanceId);
 
 /**  EDMA3 TC0 Error Interrupt Handler ISR Routine */
-extern void lisrEdma3TC0ErrHandler0(uint32_t arg);
+extern void lisrEdma3TC0ErrHandler0(uint32_t edma3InstanceId);
 /**  EDMA3 TC1 Error Interrupt Handler ISR Routine */
-extern void lisrEdma3TC1ErrHandler0(uint32_t arg);
+extern void lisrEdma3TC1ErrHandler0(uint32_t edma3InstanceId);
 /**  EDMA3 TC2 Error Interrupt Handler ISR Routine */
-extern void lisrEdma3TC2ErrHandler0(uint32_t arg);
+extern void lisrEdma3TC2ErrHandler0(uint32_t edma3InstanceId);
 /**  EDMA3 TC3 Error Interrupt Handler ISR Routine */
-extern void lisrEdma3TC3ErrHandler0(uint32_t arg);
+extern void lisrEdma3TC3ErrHandler0(uint32_t edma3InstanceId);
 /**  EDMA3 TC4 Error Interrupt Handler ISR Routine */
-extern void lisrEdma3TC4ErrHandler0(uint32_t arg);
+extern void lisrEdma3TC4ErrHandler0(uint32_t edma3InstanceId);
 /**  EDMA3 TC5 Error Interrupt Handler ISR Routine */
-extern void lisrEdma3TC5ErrHandler0(uint32_t arg);
+extern void lisrEdma3TC5ErrHandler0(uint32_t edma3InstanceId);
 /**  EDMA3 TC6 Error Interrupt Handler ISR Routine */
-extern void lisrEdma3TC6ErrHandler0(uint32_t arg);
+extern void lisrEdma3TC6ErrHandler0(uint32_t edma3InstanceId);
 /**  EDMA3 TC7 Error Interrupt Handler ISR Routine */
-extern void lisrEdma3TC7ErrHandler0(uint32_t arg);
+extern void lisrEdma3TC7ErrHandler0(uint32_t edma3InstanceId);
 
 /**
  * Defines for the level of OS protection needed when calling
@@ -308,7 +308,7 @@ extern void edma3OsProtectExit (uint32_t edma3InstanceId,
  *
  * \return  EDMA3_DRV_Result if successful else a suitable error code
  */
-extern EDMA3_DRV_Result edma3OsSemTake (EDMA3_OS_Sem_Handle hSem,
+extern EDMA3_Result edma3OsSemTake (EDMA3_OS_Sem_Handle hSem,
                                         int32_t mSecTimeout);
 
 /**
@@ -321,7 +321,7 @@ extern EDMA3_DRV_Result edma3OsSemTake (EDMA3_OS_Sem_Handle hSem,
  *
  * \return  EDMA3_DRV_Result if successful else a suitable error code
  */
-extern EDMA3_DRV_Result edma3OsSemGive(EDMA3_OS_Sem_Handle hSem);
+extern EDMA3_Result edma3OsSemGive(EDMA3_OS_Sem_Handle hSem);
 
 #ifdef __cplusplus
 }