Actuator board 3.1

firmware/actuator_board/ActuatorBoardV3.0/src/can.h → firmware/actuator_board/ActuatorBoardV3.0/firmware/src/can.h

@@ -1,178 +1,178 @@
-/* ************************************************************************** */
-/** Descriptive File Name
-
-  @Company
-    Company Name
-
-  @File Name
-    filename.h
-
-  @Summary
-    Brief description of the file.
-
-  @Description
-    Describe the purpose of this file.
- */
-/* ************************************************************************** */
-#include "config/default/peripheral/canfd/plib_canfd_common.h"
-
-#ifndef CAN_H /* Guard against multiple inclusion */
-#define CAN_H
-
-
-
-/* ************************************************************************** */
-/* ************************************************************************** */
-/* Section: Included Files                                                    */
-/* ************************************************************************** */
-/* ************************************************************************** */
-
-/* This section lists the other files that are included in this file.
- */
-
-/* TODO:  Include other files here if needed. */
-
-
-/* Provide C++ Compatibility */
-
-
-    /* ************************************************************************** */
-    /* ************************************************************************** */
-    /* Section: Constants                                                         */
-    /* ************************************************************************** */
-    /* ************************************************************************** */
-
-    /*  A brief description of a section can be given directly below the section
-        banner.
-     */
-
-
-    /* ************************************************************************** */
-    /** Descriptive Constant Name
-
-      @Summary
-        Brief one-line summary of the constant.
-    
-      @Description
-        Full description, explaining the purpose and usage of the constant.
-        <p>
-        Additional description in consecutive paragraphs separated by HTML 
-        paragraph breaks, as necessary.
-        <p>
-        Type "JavaDoc" in the "How Do I?" IDE toolbar for more information on tags.
-    
-      @Remarks
-        Any additional remarks
-     */
-#define EXAMPLE_CONSTANT 0
-
-
-    // *****************************************************************************
-    // *****************************************************************************
-    // Section: Data Types
-    // *****************************************************************************
-    // *****************************************************************************
-
-    /*  A brief description of a section can be given directly below the section
-        banner.
-     */
-
-
-    // *****************************************************************************
-
-    /** Descriptive Data Type Name
-
-      @Summary
-        Brief one-line summary of the data type.
-    
-      @Description
-        Full description, explaining the purpose and usage of the data type.
-        <p>
-        Additional description in consecutive paragraphs separated by HTML 
-        paragraph breaks, as necessary.
-        <p>
-        Type "JavaDoc" in the "How Do I?" IDE toolbar for more information on tags.
-
-      @Remarks
-        Any additional remarks
-        <p>
-        Describe enumeration elements and structure and union members above each 
-        element or member.
-     */
-    typedef struct _canMsg{
-        /* Describe structure member. */
-        uint32_t ID;
-        uint8_t length;
-        uint8_t data[8];
-        CANFD_MSG_RX_ATTRIBUTE msgAttr;
-
-    } can_t;
-
-
-    // *****************************************************************************
-    // *****************************************************************************
-    // Section: Interface Functions
-    // *****************************************************************************
-    // *****************************************************************************
-
-    /*  A brief description of a section can be given directly below the section
-        banner.
-     */
-
-    // *****************************************************************************
-    /**
-      @Function
-        int ExampleFunctionName ( int param1, int param2 ) 
-
-      @Summary
-        Brief one-line description of the function.
-
-      @Description
-        Full description, explaining the purpose and usage of the function.
-        <p>
-        Additional description in consecutive paragraphs separated by HTML 
-        paragraph breaks, as necessary.
-        <p>
-        Type "JavaDoc" in the "How Do I?" IDE toolbar for more information on tags.
-
-      @Precondition
-        List and describe any required preconditions. If there are no preconditions,
-        enter "None."
-
-      @Parameters
-        @param param1 Describe the first parameter to the function.
-    
-        @param param2 Describe the second parameter to the function.
-
-      @Returns
-        List (if feasible) and describe the return values of the function.
-        <ul>
-          <li>1   Indicates an error occurred
-          <li>0   Indicates an error did not occur
-        </ul>
-
-      @Remarks
-        Describe any special behavior not described above.
-        <p>
-        Any additional remarks.
-
-      @Example
-        @code
-        if(ExampleFunctionName(1, 2) == 0)
-        {
-            return 3;
-        }
-     */
-    int ExampleFunction(int param1, int param2);
-
-
-    /* Provide C++ Compatibility */
-#ifdef __cplusplus
-}
-#endif
-
-#endif /* _EXAMPLE_FILE_NAME_H */
-
-/* *****************************************************************************
- End of File
- */
+/* ************************************************************************** */
+/** Descriptive File Name
+
+  @Company
+    Company Name
+
+  @File Name
+    filename.h
+
+  @Summary
+    Brief description of the file.
+
+  @Description
+    Describe the purpose of this file.
+ */
+/* ************************************************************************** */
+#include "config/default/peripheral/canfd/plib_canfd_common.h"
+
+#ifndef CAN_H /* Guard against multiple inclusion */
+#define CAN_H
+
+
+
+/* ************************************************************************** */
+/* ************************************************************************** */
+/* Section: Included Files                                                    */
+/* ************************************************************************** */
+/* ************************************************************************** */
+
+/* This section lists the other files that are included in this file.
+ */
+
+/* TODO:  Include other files here if needed. */
+
+
+/* Provide C++ Compatibility */
+
+
+    /* ************************************************************************** */
+    /* ************************************************************************** */
+    /* Section: Constants                                                         */
+    /* ************************************************************************** */
+    /* ************************************************************************** */
+
+    /*  A brief description of a section can be given directly below the section
+        banner.
+     */
+
+
+    /* ************************************************************************** */
+    /** Descriptive Constant Name
+
+      @Summary
+        Brief one-line summary of the constant.
+
+      @Description
+        Full description, explaining the purpose and usage of the constant.
+        <p>
+        Additional description in consecutive paragraphs separated by HTML 
+        paragraph breaks, as necessary.
+        <p>
+        Type "JavaDoc" in the "How Do I?" IDE toolbar for more information on tags.
+
+      @Remarks
+        Any additional remarks
+     */
+#define EXAMPLE_CONSTANT 0
+
+
+    // *****************************************************************************
+    // *****************************************************************************
+    // Section: Data Types
+    // *****************************************************************************
+    // *****************************************************************************
+
+    /*  A brief description of a section can be given directly below the section
+        banner.
+     */
+
+
+    // *****************************************************************************
+
+    /** Descriptive Data Type Name
+
+      @Summary
+        Brief one-line summary of the data type.
+
+      @Description
+        Full description, explaining the purpose and usage of the data type.
+        <p>
+        Additional description in consecutive paragraphs separated by HTML 
+        paragraph breaks, as necessary.
+        <p>
+        Type "JavaDoc" in the "How Do I?" IDE toolbar for more information on tags.
+
+      @Remarks
+        Any additional remarks
+        <p>
+        Describe enumeration elements and structure and union members above each 
+        element or member.
+     */
+    typedef struct _canMsg{
+        /* Describe structure member. */
+        uint32_t ID;
+        uint8_t length;
+        uint8_t data[8];
+        CANFD_MSG_RX_ATTRIBUTE msgAttr;
+
+    } can_t;
+
+
+    // *****************************************************************************
+    // *****************************************************************************
+    // Section: Interface Functions
+    // *****************************************************************************
+    // *****************************************************************************
+
+    /*  A brief description of a section can be given directly below the section
+        banner.
+     */
+
+    // *****************************************************************************
+    /**
+      @Function
+        int ExampleFunctionName ( int param1, int param2 ) 
+
+      @Summary
+        Brief one-line description of the function.
+
+      @Description
+        Full description, explaining the purpose and usage of the function.
+        <p>
+        Additional description in consecutive paragraphs separated by HTML 
+        paragraph breaks, as necessary.
+        <p>
+        Type "JavaDoc" in the "How Do I?" IDE toolbar for more information on tags.
+
+      @Precondition
+        List and describe any required preconditions. If there are no preconditions,
+        enter "None."
+
+      @Parameters
+        @param param1 Describe the first parameter to the function.
+
+        @param param2 Describe the second parameter to the function.
+
+      @Returns
+        List (if feasible) and describe the return values of the function.
+        <ul>
+          <li>1   Indicates an error occurred
+          <li>0   Indicates an error did not occur
+        </ul>
+
+      @Remarks
+        Describe any special behavior not described above.
+        <p>
+        Any additional remarks.
+
+      @Example
+        @code
+        if(ExampleFunctionName(1, 2) == 0)
+        {
+            return 3;
+        }
+     */
+    int ExampleFunction(int param1, int param2);
+
+
+    /* Provide C++ Compatibility */
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* _EXAMPLE_FILE_NAME_H */
+
+/* *****************************************************************************
+ End of File
+ */