diff options
Diffstat (limited to 'lcmodule/source/cnh1605551_ldr_utilities/include')
| -rw-r--r-- | lcmodule/source/cnh1605551_ldr_utilities/include/r_debug_macro.h | 12 | ||||
| -rw-r--r-- | lcmodule/source/cnh1605551_ldr_utilities/include/r_memory_utils.h (renamed from lcmodule/source/cnh1605551_ldr_utilities/include/r_memmory_utils.h) | 5 | ||||
| -rw-r--r-- | lcmodule/source/cnh1605551_ldr_utilities/include/r_queue.h | 22 | ||||
| -rw-r--r-- | lcmodule/source/cnh1605551_ldr_utilities/include/r_serialization.h | 35 |
4 files changed, 35 insertions, 39 deletions
diff --git a/lcmodule/source/cnh1605551_ldr_utilities/include/r_debug_macro.h b/lcmodule/source/cnh1605551_ldr_utilities/include/r_debug_macro.h index 43f9e88..4faf681 100644 --- a/lcmodule/source/cnh1605551_ldr_utilities/include/r_debug_macro.h +++ b/lcmodule/source/cnh1605551_ldr_utilities/include/r_debug_macro.h @@ -79,9 +79,7 @@ { \ if(!(Condition)) \ { \ - {\ - INT_DISABLE()\ - }\ + INT_DISABLE()\ while(1); \ } \ } while(0) @@ -143,9 +141,7 @@ if(!(Condition)) \ { \ A_(printf("%s (%d): ** Assert failed **\n",__FILE__, __LINE__);)\ - {\ - INT_DISABLE()\ - }\ + INT_DISABLE()\ while(1); \ } \ } while(0) @@ -155,9 +151,7 @@ { \ if(!(Condition)) \ { \ - {\ - INT_DISABLE()\ - }\ + INT_DISABLE()\ while(1); \ } \ } while(0) diff --git a/lcmodule/source/cnh1605551_ldr_utilities/include/r_memmory_utils.h b/lcmodule/source/cnh1605551_ldr_utilities/include/r_memory_utils.h index fb4d54f..ee5eb18 100644 --- a/lcmodule/source/cnh1605551_ldr_utilities/include/r_memmory_utils.h +++ b/lcmodule/source/cnh1605551_ldr_utilities/include/r_memory_utils.h @@ -8,7 +8,7 @@ /** * @addtogroup ldr_utilities * @{ - * @addtogroup memmory_utils + * @addtogroup memory_utils * @{ */ @@ -52,9 +52,8 @@ if (NULL != (Buffer)) \ * variable ReturnValue to appropriate error code and send the function to error * label. * - * @param [in] x Variable for alignemend check. + * @param [in] x Variable for alignment check. * - * @sigbased No - Macro */ #define IS_ALIGNED(x) if(((x) & 3)) \ { \ diff --git a/lcmodule/source/cnh1605551_ldr_utilities/include/r_queue.h b/lcmodule/source/cnh1605551_ldr_utilities/include/r_queue.h index 06e9d17..abf0904 100644 --- a/lcmodule/source/cnh1605551_ldr_utilities/include/r_queue.h +++ b/lcmodule/source/cnh1605551_ldr_utilities/include/r_queue.h @@ -61,12 +61,12 @@ void Do_Fifo_Destroy(void *Object_p, void **const Queue_pp); * reentrant across different queues, but enqueueing on the same queue is * not necessarily reentrant. * - * @param [in] Object_p - Pointer to LCM instance context. - * @param [in] Queue_p - The queue to append to. - * @param [in] Value_p - The value to enqueue. + * @param [in] Object_p Pointer to LCM instance context. + * @param [in] Queue_p The queue to append to. + * @param [in] Value_p The value to enqueue. * @return E_SUCCESS - The function completed successfully. * - * @return E_FAILED_TO_STORE_IN_FIFO - Faliled to store data in fifo. + * @return E_FAILED_TO_STORE_IN_FIFO - Failed to store data in fifo. */ ErrorCode_e Do_Fifo_Enqueue(void *Object_p, void *const Queue_p, @@ -174,8 +174,8 @@ void Do_RFifo_Create(void *Object_p, /** * @brief Releases any resources associated with the specified queue structure. * - * @param [in] Object_p - Pointer to LCM instance context. - * @param [in,out] Queue_pp - Pointer to the queue structure to destroy. + * @param [in] Object_p Pointer to LCM instance context. + * @param [in,out] Queue_pp Pointer to the queue structure to destroy. */ void Do_RFifo_Destroy(void *Object_p, void **const Queue_pp); @@ -184,10 +184,10 @@ void Do_RFifo_Destroy(void *Object_p, void **const Queue_pp); * * Enqueueing function of a re-entrant, interrupt-safe FIFO queue. * - * @param [in] Object_p - Pointer to LCM instance context. - * @param [in] Queue_p - The queue to append to. - * @param [in] Value_p - The value to enqueue. - * @return E_SUCCESS - The function completed successfully. + * @param [in] Object_p Pointer to LCM instance context. + * @param [in] Queue_p The queue to append to. + * @param [in] Value_p The value to enqueue. + * @return E_SUCCESS The function completed successfully. * * @return E_FAILED_TO_STORE_IN_FIFO - Faliled to store data in fifo. */ @@ -226,7 +226,7 @@ void *Do_RFifo_Dequeue(void *Object_p, void *const Queue_p); * function should be called each time the queue has * transitioned from an empty to a non-empty state. * @param [in] Callback The function to call when the specified event occurs - * or NULL to unregister a previously registered func. + * or NULL to unregister a previously registered functions. * @param [in] Param_p Parameter to pass to the callback function. * @return The previously registered callback function for this * type. diff --git a/lcmodule/source/cnh1605551_ldr_utilities/include/r_serialization.h b/lcmodule/source/cnh1605551_ldr_utilities/include/r_serialization.h index b0cebd6..15a59bd 100644 --- a/lcmodule/source/cnh1605551_ldr_utilities/include/r_serialization.h +++ b/lcmodule/source/cnh1605551_ldr_utilities/include/r_serialization.h @@ -36,7 +36,9 @@ ******************************************************************************/ #include "t_basicdefinitions.h" #include "t_serialization.h" +#if defined(CFG_ENABLE_LOADER_SERIALIZATION) #include "command_ids.h" +#endif /******************************************************************************* * Declaration of functions @@ -320,9 +322,19 @@ void skip_block(void **data_pp, */ char *skip_str(void **data_pp); +/** + * @brief Serialize device entries. + * + * @param [out] data_pp Pointer of serialized data for device entries. + * @param [in] source_p Source. + * @param [in] length length of source string. + * @return void. + */ +void insert_string(char **data_pp, const char *source_p, uint32 length); +#if defined(CFG_ENABLE_LOADER_SERIALIZATION) /** - * @brief Get directory entries length...TODO: should be explained. + * @brief Get directory entries length. * * @param [out] source_p Source. * @param [in] DirectoryEntriesCount Entry counter. @@ -332,9 +344,9 @@ uint32 get_directory_entries_len(const DirEntry_t *source_p, uint32 DirectoryEntriesCount); /** - * @brief Serialize directory entries...TODO: should be explained. + * @brief Serialize directory entries. * - * @param [out] data_pp /...TODO: should be explained. + * @param [out] data_pp Pointer of serialized data for directory entries. * @param [in] source_p Source. * @param [in] DirectoryEntriesCount Entry counter. * @return void. @@ -344,7 +356,7 @@ void serialize_directory_entries(void **data_pp, uint32 DirectoryEntriesCount); /** - * @brief Get device entry length...TODO: should be explained. + * @brief Get device entry length. * * @param [out] source_p Source. * @param [in] DeviceEntriesCount Entry counter. @@ -354,9 +366,9 @@ uint32 get_device_entries_len(const ListDevice_t *source_p, uint32 DeviceEntriesCount); /** - * @brief Serialize device entries...TODO: should be explained. + * @brief Serialize device entries. * - * @param [out] data_pp /...TODO: should be explained. + * @param [out] data_pp Pointer of serialized data for device entries. * @param [in] source_p Source. * @param [in] DeviceEntriesCount Entry counter. * @return void. @@ -364,16 +376,7 @@ uint32 get_device_entries_len(const ListDevice_t *source_p, void serialize_device_entries(void **data_pp, const ListDevice_t *source_p, uint32 DeviceEntriesCount); - -/** - * @brief Serialize device entries...TODO: should be explained. - * - * @param [out] data_pp /...TODO: should be explained. - * @param [in] source_p Source. - * @param [in] length length of source string. - * @return void. - */ -void insert_string(char **data_pp, const char *source_p, uint32 length); +#endif /** @} */ /** @} */ |