From 5f664fed3d6222fa227c2ca505716894a6e0f848 Mon Sep 17 00:00:00 2001 From: Avi Date: Mon, 23 Jan 2023 10:47:16 +1000 Subject: [PATCH] Fix #1353, Align mismatched function prototype/implementation parameter names --- src/os/inc/osapi-file.h | 2 +- src/os/inc/osapi-module.h | 2 +- src/os/inc/osapi-timer.h | 2 +- src/os/portable/os-impl-no-symtab.c | 2 +- src/os/portable/os-impl-posix-dl-symtab.c | 2 +- src/os/portable/os-impl-posix-files.c | 14 +++++------ src/os/posix/src/os-impl-idmap.c | 4 ++-- src/os/rtems/src/os-impl-idmap.c | 6 ++--- src/os/shared/src/osapi-file.c | 10 ++++---- src/os/shared/src/osapi-idmap.c | 4 ++-- src/os/shared/src/osapi-module.c | 24 +++++++++---------- src/os/shared/src/osapi-time.c | 11 +++++---- src/os/shared/src/osapi-timebase.c | 20 ++++++++-------- src/os/vxworks/src/os-impl-idmap.c | 6 ++--- .../time-base-api-test/time-base-api-test.c | 8 +++---- .../timer-add-api-test/timer-add-api-test.c | 2 +- .../portable/src/coveragetest-posix-files.c | 2 +- .../shared/src/coveragetest-file.c | 2 +- .../shared/src/coveragetest-module.c | 4 ++-- .../shared/src/coveragetest-time.c | 5 ++-- .../shared/src/coveragetest-timebase.c | 8 +++---- .../vxworks/src/coveragetest-idmap.c | 2 +- .../vxworks/src/coveragetest-symtab.c | 2 +- .../vxworks/src/coveragetest-timebase.c | 2 +- .../osfile-test/ut_osfile_fileio_test.c | 6 ++--- .../ostimer-test/ut_ostimer_timerio_test.c | 2 +- 26 files changed, 78 insertions(+), 76 deletions(-) diff --git a/src/os/inc/osapi-file.h b/src/os/inc/osapi-file.h index 512157fb5..41dc10bbc 100644 --- a/src/os/inc/osapi-file.h +++ b/src/os/inc/osapi-file.h @@ -377,7 +377,7 @@ int32 OS_remove(const char *path); * @return Execution status, see @ref OSReturnCodes * @retval #OS_SUCCESS @copybrief OS_SUCCESS * @retval #OS_ERROR if the file could not be opened or renamed. - * @retval #OS_INVALID_POINTER if old or new are NULL + * @retval #OS_INVALID_POINTER if old_filename or new_filename are NULL * @retval #OS_FS_ERR_PATH_INVALID if path cannot be parsed * @retval #OS_FS_ERR_PATH_TOO_LONG if the paths given are too long to be stored locally * @retval #OS_FS_ERR_NAME_TOO_LONG if the new name is too long to be stored locally diff --git a/src/os/inc/osapi-module.h b/src/os/inc/osapi-module.h index 82ce0843a..34b4c527b 100644 --- a/src/os/inc/osapi-module.h +++ b/src/os/inc/osapi-module.h @@ -170,7 +170,7 @@ int32 OS_ModuleSymbolLookup(osal_id_t module_id, cpuaddr *symbol_address, const * module subsystem does not provide a facility to iterate through the * symbol table, then the #OS_ERR_NOT_IMPLEMENTED status code is returned. * - * @param[in] filename File to write to @nonnull + * @param[in] filename File to write to @nonnull * @param[in] size_limit Maximum number of bytes to write * * @return Execution status, see @ref OSReturnCodes diff --git a/src/os/inc/osapi-timer.h b/src/os/inc/osapi-timer.h index 6c30c5a65..eea4c5510 100644 --- a/src/os/inc/osapi-timer.h +++ b/src/os/inc/osapi-timer.h @@ -61,7 +61,7 @@ typedef struct * The callback function should be declared according to the OS_TimerCallback_t * function pointer type. The timer_id value is passed to the callback function. * - * @note clock_accuracy comes from the underlying OS tick value. The nearest integer + * @note clock_accuracy comes from the underlying OS tick value. The nearest integer * microsecond value is returned, so may not be exact. * * @note This configuration API must not be used from the context of a timer callback. diff --git a/src/os/portable/os-impl-no-symtab.c b/src/os/portable/os-impl-no-symtab.c index 868d8e508..b6d45912a 100644 --- a/src/os/portable/os-impl-no-symtab.c +++ b/src/os/portable/os-impl-no-symtab.c @@ -53,7 +53,7 @@ int32 OS_ModuleSymbolLookup_Impl(const OS_object_token_t *token, cpuaddr *Symbol * * See prototype for argument/return detail *-----------------------------------------------------------------*/ -int32 OS_SymbolTableDump_Impl(const char *filename, size_t SizeLimit) +int32 OS_SymbolTableDump_Impl(const char *filename, size_t size_limit) { return OS_ERR_NOT_IMPLEMENTED; } diff --git a/src/os/portable/os-impl-posix-dl-symtab.c b/src/os/portable/os-impl-posix-dl-symtab.c index 1a67ec19f..4722a416f 100644 --- a/src/os/portable/os-impl-posix-dl-symtab.c +++ b/src/os/portable/os-impl-posix-dl-symtab.c @@ -188,7 +188,7 @@ int32 OS_ModuleSymbolLookup_Impl(const OS_object_token_t *token, cpuaddr *Symbol * POSIX DL does not provide * *-----------------------------------------------------------------*/ -int32 OS_SymbolTableDump_Impl(const char *filename, size_t SizeLimit) +int32 OS_SymbolTableDump_Impl(const char *filename, size_t size_limit) { /* * Limiting strictly to POSIX-defined API means there is no defined diff --git a/src/os/portable/os-impl-posix-files.c b/src/os/portable/os-impl-posix-files.c index 326b27ea2..98b323b3d 100644 --- a/src/os/portable/os-impl-posix-files.c +++ b/src/os/portable/os-impl-posix-files.c @@ -126,7 +126,7 @@ int32 OS_FileOpen_Impl(const OS_object_token_t *token, const char *local_path, i * See prototype for argument/return detail * *-----------------------------------------------------------------*/ -int32 OS_FileStat_Impl(const char *local_path, os_fstat_t *FileStats) +int32 OS_FileStat_Impl(const char *local_path, os_fstat_t *filestat) { struct stat st; mode_t readbits; @@ -139,7 +139,7 @@ int32 OS_FileStat_Impl(const char *local_path, os_fstat_t *FileStats) return OS_ERROR; } - FileStats->FileSize = st.st_size; + filestat->FileSize = st.st_size; /* * NOTE: Traditional timestamps are only a whole number of seconds (time_t) @@ -164,12 +164,12 @@ int32 OS_FileStat_Impl(const char *local_path, os_fstat_t *FileStats) filetime.tv_nsec = 0; #endif - FileStats->FileTime = OS_TimeAssembleFromNanoseconds(filetime.tv_sec, filetime.tv_nsec); + filestat->FileTime = OS_TimeAssembleFromNanoseconds(filetime.tv_sec, filetime.tv_nsec); /* note that the "fst_mode" member is already zeroed by the caller */ if (S_ISDIR(st.st_mode)) { - FileStats->FileModeBits |= OS_FILESTAT_MODE_DIR; + filestat->FileModeBits |= OS_FILESTAT_MODE_DIR; } /* always check world bits */ @@ -195,15 +195,15 @@ int32 OS_FileStat_Impl(const char *local_path, os_fstat_t *FileStats) if (st.st_mode & readbits) { - FileStats->FileModeBits |= OS_FILESTAT_MODE_READ; + filestat->FileModeBits |= OS_FILESTAT_MODE_READ; } if (st.st_mode & writebits) { - FileStats->FileModeBits |= OS_FILESTAT_MODE_WRITE; + filestat->FileModeBits |= OS_FILESTAT_MODE_WRITE; } if (st.st_mode & execbits) { - FileStats->FileModeBits |= OS_FILESTAT_MODE_EXEC; + filestat->FileModeBits |= OS_FILESTAT_MODE_EXEC; } return OS_SUCCESS; diff --git a/src/os/posix/src/os-impl-idmap.c b/src/os/posix/src/os-impl-idmap.c index b253f5f92..bf5ca1b4f 100644 --- a/src/os/posix/src/os-impl-idmap.c +++ b/src/os/posix/src/os-impl-idmap.c @@ -134,12 +134,12 @@ void OS_Unlock_Global_Impl(osal_objtype_t idtype) * See prototype for argument/return detail * *-----------------------------------------------------------------*/ -void OS_WaitForStateChange_Impl(osal_objtype_t idtype, uint32 attempts) +void OS_WaitForStateChange_Impl(osal_objtype_t objtype, uint32 attempts) { OS_impl_objtype_lock_t *impl; struct timespec ts; - impl = OS_impl_objtype_lock_table[idtype]; + impl = OS_impl_objtype_lock_table[objtype]; /* * because pthread_cond_timedwait() is also a cancellation point, diff --git a/src/os/rtems/src/os-impl-idmap.c b/src/os/rtems/src/os-impl-idmap.c index 565c615d5..004fa7e73 100644 --- a/src/os/rtems/src/os-impl-idmap.c +++ b/src/os/rtems/src/os-impl-idmap.c @@ -126,7 +126,7 @@ void OS_Unlock_Global_Impl(osal_objtype_t idtype) * See prototype for argument/return detail * *-----------------------------------------------------------------*/ -void OS_WaitForStateChange_Impl(osal_objtype_t idtype, uint32 attempts) +void OS_WaitForStateChange_Impl(osal_objtype_t objtype, uint32 attempts) { rtems_interval wait_ticks; @@ -139,9 +139,9 @@ void OS_WaitForStateChange_Impl(osal_objtype_t idtype, uint32 attempts) wait_ticks = 100; } - OS_Unlock_Global_Impl(idtype); + OS_Unlock_Global_Impl(objtype); rtems_task_wake_after(wait_ticks); - OS_Lock_Global_Impl(idtype); + OS_Lock_Global_Impl(objtype); } /**************************************************************************************** diff --git a/src/os/shared/src/osapi-file.c b/src/os/shared/src/osapi-file.c index ebe77b98a..da5eb7a05 100644 --- a/src/os/shared/src/osapi-file.c +++ b/src/os/shared/src/osapi-file.c @@ -342,7 +342,7 @@ int32 OS_remove(const char *path) * See description in API and header file for detail * *-----------------------------------------------------------------*/ -int32 OS_rename(const char *old, const char *new) +int32 OS_rename(const char *old_filename, const char *new_filename) { OS_object_iter_t iter; OS_stream_internal_record_t *stream; @@ -350,10 +350,10 @@ int32 OS_rename(const char *old, const char *new) char old_path[OS_MAX_LOCAL_PATH_LEN]; char new_path[OS_MAX_LOCAL_PATH_LEN]; - return_code = OS_TranslatePath(old, old_path); + return_code = OS_TranslatePath(old_filename, old_path); if (return_code == OS_SUCCESS) { - return_code = OS_TranslatePath(new, new_path); + return_code = OS_TranslatePath(new_filename, new_path); } if (return_code == OS_SUCCESS) @@ -369,9 +369,9 @@ int32 OS_rename(const char *old, const char *new) { stream = OS_OBJECT_TABLE_GET(OS_stream_table, iter.token); - if (stream->socket_domain == OS_SocketDomain_INVALID && strcmp(stream->stream_name, old) == 0) + if (stream->socket_domain == OS_SocketDomain_INVALID && strcmp(stream->stream_name, old_filename) == 0) { - strncpy(stream->stream_name, new, sizeof(stream->stream_name) - 1); + strncpy(stream->stream_name, new_filename, sizeof(stream->stream_name) - 1); stream->stream_name[sizeof(stream->stream_name) - 1] = 0; } } diff --git a/src/os/shared/src/osapi-idmap.c b/src/os/shared/src/osapi-idmap.c index 142875992..207886fd1 100644 --- a/src/os/shared/src/osapi-idmap.c +++ b/src/os/shared/src/osapi-idmap.c @@ -1359,7 +1359,7 @@ void OS_ForEachObject(osal_id_t creator_id, OS_ArgCallback_t callback_ptr, void * See description in API and header file for detail * *-----------------------------------------------------------------*/ -void OS_ForEachObjectOfType(osal_objtype_t idtype, osal_id_t creator_id, OS_ArgCallback_t callback_ptr, +void OS_ForEachObjectOfType(osal_objtype_t objtype, osal_id_t creator_id, OS_ArgCallback_t callback_ptr, void *callback_arg) { OS_object_iter_t iter; @@ -1369,7 +1369,7 @@ void OS_ForEachObjectOfType(osal_objtype_t idtype, osal_id_t creator_id, OS_ArgC filter.user_callback = callback_ptr; filter.user_arg = callback_arg; - if (OS_ObjectIdIteratorInit(OS_ForEachFilterCreator, &filter, idtype, &iter) == OS_SUCCESS) + if (OS_ObjectIdIteratorInit(OS_ForEachFilterCreator, &filter, objtype, &iter) == OS_SUCCESS) { while (OS_ObjectIdIteratorGetNext(&iter)) { diff --git a/src/os/shared/src/osapi-module.c b/src/os/shared/src/osapi-module.c index 34aec122b..2c320d207 100644 --- a/src/os/shared/src/osapi-module.c +++ b/src/os/shared/src/osapi-module.c @@ -296,7 +296,7 @@ int32 OS_ModuleUnload(osal_id_t module_id) * See description in API and header file for detail * *-----------------------------------------------------------------*/ -int32 OS_ModuleInfo(osal_id_t module_id, OS_module_prop_t *module_prop) +int32 OS_ModuleInfo(osal_id_t module_id, OS_module_prop_t *module_info) { OS_common_record_t * record; OS_module_internal_record_t *module; @@ -304,9 +304,9 @@ int32 OS_ModuleInfo(osal_id_t module_id, OS_module_prop_t *module_prop) OS_object_token_t token; /* Check parameters */ - OS_CHECK_POINTER(module_prop); + OS_CHECK_POINTER(module_info); - memset(module_prop, 0, sizeof(OS_module_prop_t)); + memset(module_info, 0, sizeof(OS_module_prop_t)); return_code = OS_ObjectIdGetById(OS_LOCK_MODE_GLOBAL, LOCAL_OBJID_TYPE, module_id, &token); if (return_code == OS_SUCCESS) @@ -314,10 +314,10 @@ int32 OS_ModuleInfo(osal_id_t module_id, OS_module_prop_t *module_prop) record = OS_OBJECT_TABLE_GET(OS_global_module_table, token); module = OS_OBJECT_TABLE_GET(OS_module_table, token); - strncpy(module_prop->name, record->name_entry, sizeof(module_prop->name) - 1); - strncpy(module_prop->filename, module->file_name, sizeof(module_prop->filename) - 1); + strncpy(module_info->name, record->name_entry, sizeof(module_info->name) - 1); + strncpy(module_info->filename, module->file_name, sizeof(module_info->filename) - 1); - return_code = OS_ModuleGetInfo_Impl(&token, module_prop); + return_code = OS_ModuleGetInfo_Impl(&token, module_info); OS_ObjectIdRelease(&token); } @@ -331,7 +331,7 @@ int32 OS_ModuleInfo(osal_id_t module_id, OS_module_prop_t *module_prop) * See description in API and header file for detail * *-----------------------------------------------------------------*/ -int32 OS_SymbolLookup(cpuaddr *SymbolAddress, const char *SymbolName) +int32 OS_SymbolLookup(cpuaddr *symbol_address, const char *SymbolName) { int32 return_code; int32 staticsym_status; @@ -339,13 +339,13 @@ int32 OS_SymbolLookup(cpuaddr *SymbolAddress, const char *SymbolName) /* ** Check parameters */ - OS_CHECK_POINTER(SymbolAddress); + OS_CHECK_POINTER(symbol_address); OS_CHECK_POINTER(SymbolName); /* * attempt to find the symbol in the symbol table */ - return_code = OS_SymbolLookup_Impl(SymbolAddress, SymbolName); + return_code = OS_SymbolLookup_Impl(symbol_address, SymbolName); /* * If the OS call did not find the symbol or the loader is @@ -353,7 +353,7 @@ int32 OS_SymbolLookup(cpuaddr *SymbolAddress, const char *SymbolName) */ if (return_code != OS_SUCCESS) { - staticsym_status = OS_SymbolLookup_Static(SymbolAddress, SymbolName, NULL); + staticsym_status = OS_SymbolLookup_Static(symbol_address, SymbolName, NULL); /* * Only overwrite the return code if static lookup was successful. @@ -420,7 +420,7 @@ int32 OS_ModuleSymbolLookup(osal_id_t module_id, cpuaddr *symbol_address, const * See description in API and header file for detail * *-----------------------------------------------------------------*/ -int32 OS_SymbolTableDump(const char *filename, size_t SizeLimit) +int32 OS_SymbolTableDump(const char *filename, size_t size_limit) { int32 return_code; char translated_path[OS_MAX_LOCAL_PATH_LEN]; @@ -453,7 +453,7 @@ int32 OS_SymbolTableDump(const char *filename, size_t SizeLimit) return return_code; } - return_code = OS_SymbolTableDump_Impl(translated_path, SizeLimit); + return_code = OS_SymbolTableDump_Impl(translated_path, size_limit); OS_ObjectIdTransactionCancel(&token); diff --git a/src/os/shared/src/osapi-time.c b/src/os/shared/src/osapi-time.c index c9dd57bf0..65f02255c 100644 --- a/src/os/shared/src/osapi-time.c +++ b/src/os/shared/src/osapi-time.c @@ -197,10 +197,10 @@ static int32 OS_DoTimerAdd(osal_id_t *timer_id, const char *timer_name, osal_id_ * See description in API and header file for detail * *-----------------------------------------------------------------*/ -int32 OS_TimerAdd(osal_id_t *timer_id, const char *timer_name, osal_id_t timebase_ref_id, OS_ArgCallback_t callback_ptr, +int32 OS_TimerAdd(osal_id_t *timer_id, const char *timer_name, osal_id_t timebase_id, OS_ArgCallback_t callback_ptr, void *callback_arg) { - return (OS_DoTimerAdd(timer_id, timer_name, timebase_ref_id, callback_ptr, callback_arg, 0)); + return (OS_DoTimerAdd(timer_id, timer_name, timebase_id, callback_ptr, callback_arg, 0)); } /*---------------------------------------------------------------- @@ -226,7 +226,8 @@ static void OS_Timer_NoArgCallback(osal_id_t objid, void *arg) * See description in API and header file for detail * *-----------------------------------------------------------------*/ -int32 OS_TimerCreate(osal_id_t *timer_id, const char *timer_name, uint32 *accuracy, OS_TimerCallback_t callback_ptr) +int32 OS_TimerCreate(osal_id_t *timer_id, const char *timer_name, uint32 *clock_accuracy, + OS_TimerCallback_t callback_ptr) { int32 return_code; osal_id_t timebase_ref_id; @@ -239,7 +240,7 @@ int32 OS_TimerCreate(osal_id_t *timer_id, const char *timer_name, uint32 *accura */ OS_CHECK_POINTER(timer_id); OS_CHECK_APINAME(timer_name); - OS_CHECK_POINTER(accuracy); + OS_CHECK_POINTER(clock_accuracy); OS_CHECK_POINTER(callback_ptr); /* @@ -277,7 +278,7 @@ int32 OS_TimerCreate(osal_id_t *timer_id, const char *timer_name, uint32 *accura } else { - *accuracy = OS_SharedGlobalVars.MicroSecPerTick; + *clock_accuracy = OS_SharedGlobalVars.MicroSecPerTick; } return return_code; diff --git a/src/os/shared/src/osapi-timebase.c b/src/os/shared/src/osapi-timebase.c index 810cb61c9..28cb096e2 100644 --- a/src/os/shared/src/osapi-timebase.c +++ b/src/os/shared/src/osapi-timebase.c @@ -90,7 +90,7 @@ int32 OS_TimeBaseAPI_Init(void) * See description in API and header file for detail * *-----------------------------------------------------------------*/ -int32 OS_TimeBaseCreate(osal_id_t *timer_id, const char *timebase_name, OS_TimerSync_t external_sync) +int32 OS_TimeBaseCreate(osal_id_t *timebase_id, const char *timebase_name, OS_TimerSync_t external_sync) { int32 return_code; osal_objtype_t objtype; @@ -105,7 +105,7 @@ int32 OS_TimeBaseCreate(osal_id_t *timer_id, const char *timebase_name, OS_Timer /* ** Check Parameters */ - OS_CHECK_POINTER(timer_id); + OS_CHECK_POINTER(timebase_id); OS_CHECK_APINAME(timebase_name); /* @@ -141,7 +141,7 @@ int32 OS_TimeBaseCreate(osal_id_t *timer_id, const char *timebase_name, OS_Timer return_code = OS_TimeBaseCreate_Impl(&token); /* Check result, finalize record, and unlock global table. */ - return_code = OS_ObjectIdFinalizeNew(return_code, &token, timer_id); + return_code = OS_ObjectIdFinalizeNew(return_code, &token, timebase_id); } return return_code; @@ -153,7 +153,7 @@ int32 OS_TimeBaseCreate(osal_id_t *timer_id, const char *timebase_name, OS_Timer * See description in API and header file for detail * *-----------------------------------------------------------------*/ -int32 OS_TimeBaseSet(osal_id_t timer_id, uint32 start_time, uint32 interval_time) +int32 OS_TimeBaseSet(osal_id_t timebase_id, uint32 start_time, uint32 interval_time) { int32 return_code; osal_objtype_t objtype; @@ -181,7 +181,7 @@ int32 OS_TimeBaseSet(osal_id_t timer_id, uint32 start_time, uint32 interval_time return OS_ERR_INCORRECT_OBJ_STATE; } - return_code = OS_ObjectIdGetById(OS_LOCK_MODE_GLOBAL, OS_OBJECT_TYPE_OS_TIMEBASE, timer_id, &token); + return_code = OS_ObjectIdGetById(OS_LOCK_MODE_GLOBAL, OS_OBJECT_TYPE_OS_TIMEBASE, timebase_id, &token); if (return_code == OS_SUCCESS) { timebase = OS_OBJECT_TABLE_GET(OS_timebase_table, token); @@ -212,7 +212,7 @@ int32 OS_TimeBaseSet(osal_id_t timer_id, uint32 start_time, uint32 interval_time * See description in API and header file for detail * *-----------------------------------------------------------------*/ -int32 OS_TimeBaseDelete(osal_id_t timer_id) +int32 OS_TimeBaseDelete(osal_id_t timebase_id) { int32 return_code; osal_objtype_t objtype; @@ -228,7 +228,7 @@ int32 OS_TimeBaseDelete(osal_id_t timer_id) return OS_ERR_INCORRECT_OBJ_STATE; } - return_code = OS_ObjectIdGetById(OS_LOCK_MODE_EXCLUSIVE, OS_OBJECT_TYPE_OS_TIMEBASE, timer_id, &token); + return_code = OS_ObjectIdGetById(OS_LOCK_MODE_EXCLUSIVE, OS_OBJECT_TYPE_OS_TIMEBASE, timebase_id, &token); if (return_code == OS_SUCCESS) { return_code = OS_TimeBaseDelete_Impl(&token); @@ -246,13 +246,13 @@ int32 OS_TimeBaseDelete(osal_id_t timer_id) * See description in API and header file for detail * *-----------------------------------------------------------------*/ -int32 OS_TimeBaseGetIdByName(osal_id_t *timer_id, const char *timebase_name) +int32 OS_TimeBaseGetIdByName(osal_id_t *timebase_id, const char *timebase_name) { int32 return_code; osal_objtype_t objtype; /* Check parameters */ - OS_CHECK_POINTER(timer_id); + OS_CHECK_POINTER(timebase_id); OS_CHECK_APINAME(timebase_name); /* @@ -265,7 +265,7 @@ int32 OS_TimeBaseGetIdByName(osal_id_t *timer_id, const char *timebase_name) return OS_ERR_INCORRECT_OBJ_STATE; } - return_code = OS_ObjectIdFindByName(OS_OBJECT_TYPE_OS_TIMEBASE, timebase_name, timer_id); + return_code = OS_ObjectIdFindByName(OS_OBJECT_TYPE_OS_TIMEBASE, timebase_name, timebase_id); return return_code; } diff --git a/src/os/vxworks/src/os-impl-idmap.c b/src/os/vxworks/src/os-impl-idmap.c index 5d0895e96..ffdd8dfef 100644 --- a/src/os/vxworks/src/os-impl-idmap.c +++ b/src/os/vxworks/src/os-impl-idmap.c @@ -137,7 +137,7 @@ void OS_Unlock_Global_Impl(osal_objtype_t idtype) * See prototype for argument/return detail * *-----------------------------------------------------------------*/ -void OS_WaitForStateChange_Impl(osal_objtype_t idtype, uint32 attempts) +void OS_WaitForStateChange_Impl(osal_objtype_t objtype, uint32 attempts) { int wait_ticks; @@ -150,9 +150,9 @@ void OS_WaitForStateChange_Impl(osal_objtype_t idtype, uint32 attempts) wait_ticks = 100; } - OS_Unlock_Global_Impl(idtype); + OS_Unlock_Global_Impl(objtype); taskDelay(wait_ticks); - OS_Lock_Global_Impl(idtype); + OS_Lock_Global_Impl(objtype); } /**************************************************************************************** diff --git a/src/tests/time-base-api-test/time-base-api-test.c b/src/tests/time-base-api-test/time-base-api-test.c index 6ce05160a..29946751a 100644 --- a/src/tests/time-base-api-test/time-base-api-test.c +++ b/src/tests/time-base-api-test/time-base-api-test.c @@ -77,7 +77,7 @@ void TestTimeBaseApi(void) /* * Test Case For: - * int32 OS_TimeBaseCreate(uint32 *timer_id, const char *timebase_name, OS_TimerSync_t external_sync) + * int32 OS_TimeBaseCreate(osal_id_t *timebase_id, const char *timebase_name, OS_TimerSync_t external_sync) */ /* Test for invalid inputs */ @@ -123,7 +123,7 @@ void TestTimeBaseApi(void) /* * Test Case For: - * int32 OS_TimeBaseSet(uint32 timer_id, uint32 start_time, uint32 interval_time) + * int32 OS_TimeBaseSet(osal_id_t timebase_id, uint32 start_time, uint32 interval_time) */ /* Test for nominal inputs */ @@ -144,7 +144,7 @@ void TestTimeBaseApi(void) /* * Test Case For: - * int32 OS_TimeBaseDelete(uint32 timer_id) + * int32 OS_TimeBaseDelete(osal_id_t timebase_id) */ /* Test for nominal inputs */ @@ -156,7 +156,7 @@ void TestTimeBaseApi(void) /* * Test Case For: - * int32 OS_TimeBaseGetIdByName (uint32 *timer_id, const char *timebase_name) + * int32 OS_TimeBaseGetIdByName(osal_id_t *timebase_id, const char *timebase_name) */ /* Test for nominal inputs */ diff --git a/src/tests/timer-add-api-test/timer-add-api-test.c b/src/tests/timer-add-api-test/timer-add-api-test.c index 6f34f01bd..e9005912e 100644 --- a/src/tests/timer-add-api-test/timer-add-api-test.c +++ b/src/tests/timer-add-api-test/timer-add-api-test.c @@ -59,7 +59,7 @@ void TestTimerAddApi(void) { /* * Test Case For: - * int32 OS_TimerAdd(uint32 *timer_id, const char *timer_name, uint32 timebase_ref_id, OS_ArgCallback_t + * int32 OS_TimerAdd(osal_id_t *timer_id, const char *timer_name, osal_id_t timebase_id, OS_ArgCallback_t * callback_ptr, void *callback_arg) */ diff --git a/src/unit-test-coverage/portable/src/coveragetest-posix-files.c b/src/unit-test-coverage/portable/src/coveragetest-posix-files.c index c515fe414..70a1f707b 100644 --- a/src/unit-test-coverage/portable/src/coveragetest-posix-files.c +++ b/src/unit-test-coverage/portable/src/coveragetest-posix-files.c @@ -59,7 +59,7 @@ void Test_OS_FileStat_Impl(void) { /* * Test Case For: - * int32 OS_FileStat_Impl(const char *local_path, os_fstat_t *FileStats) + * int32 OS_FileStat_Impl(const char *local_path, os_fstat_t *filestat) */ os_fstat_t FileStats; struct OCS_stat RefStat; diff --git a/src/unit-test-coverage/shared/src/coveragetest-file.c b/src/unit-test-coverage/shared/src/coveragetest-file.c index 96bf1eb53..54ce227c0 100644 --- a/src/unit-test-coverage/shared/src/coveragetest-file.c +++ b/src/unit-test-coverage/shared/src/coveragetest-file.c @@ -235,7 +235,7 @@ void Test_OS_rename(void) { /* * Test Case For: - * int32 OS_rename (const char *old, const char *new) + * int32 OS_rename(const char *old_filename, const char *new_filename) */ OS_UT_SetupIterator(OS_OBJECT_TYPE_OS_STREAM, UT_INDEX_1, 3); strncpy(OS_stream_table[1].stream_name, "/cf/file1", sizeof(OS_stream_table[1].stream_name)); diff --git a/src/unit-test-coverage/shared/src/coveragetest-module.c b/src/unit-test-coverage/shared/src/coveragetest-module.c index a50c47a90..da0a52570 100644 --- a/src/unit-test-coverage/shared/src/coveragetest-module.c +++ b/src/unit-test-coverage/shared/src/coveragetest-module.c @@ -124,7 +124,7 @@ void Test_OS_SymbolLookup(void) { /* * Test Case For: - * int32 OS_SymbolLookup(cpuaddr *SymbolAddress, const char *SymbolName) + * int32 OS_SymbolLookup(cpuaddr *symbol_address, const char *SymbolName) */ int32 expected = OS_SUCCESS; int32 actual = ~OS_SUCCESS; @@ -264,7 +264,7 @@ void Test_OS_ModuleGetInfo(void) { /* * Test Case For: - * int32 OS_ModuleInfo ( uint32 module_id, OS_module_prop_t *module_prop ) + * int32 OS_ModuleInfo(uint32 module_id, OS_module_prop_t *module_info) */ OS_module_prop_t module_prop; diff --git a/src/unit-test-coverage/shared/src/coveragetest-time.c b/src/unit-test-coverage/shared/src/coveragetest-time.c index a1e30255c..017dcc9ca 100644 --- a/src/unit-test-coverage/shared/src/coveragetest-time.c +++ b/src/unit-test-coverage/shared/src/coveragetest-time.c @@ -61,7 +61,7 @@ void Test_OS_TimerAdd(void) { /* * Test Case For: - * int32 OS_TimerAdd(uint32 *timer_id, const char *timer_name, uint32 timebase_ref_id, OS_ArgCallback_t + * int32 OS_TimerAdd(osal_id_t *timer_id, const char *timer_name, osal_id_t timebase_id, OS_ArgCallback_t * callback_ptr, void *callback_arg) */ osal_id_t objid = OS_OBJECT_ID_UNDEFINED; @@ -99,7 +99,8 @@ void Test_OS_TimerCreate(void) { /* * Test Case For: - * int32 OS_TimerCreate(uint32 *timer_id, const char *timer_name, uint32 *accuracy, OS_TimerCallback_t callback_ptr) + * int32 OS_TimerCreate(osal_id_t *timer_id, const char *timer_name, uint32 *clock_accuracy, OS_TimerCallback_t + * callback_ptr) */ osal_id_t objid = OS_OBJECT_ID_UNDEFINED; osal_index_t local_id = OSAL_INDEX_C(0); diff --git a/src/unit-test-coverage/shared/src/coveragetest-timebase.c b/src/unit-test-coverage/shared/src/coveragetest-timebase.c index d25cbd88e..fb1596ab1 100644 --- a/src/unit-test-coverage/shared/src/coveragetest-timebase.c +++ b/src/unit-test-coverage/shared/src/coveragetest-timebase.c @@ -77,7 +77,7 @@ void Test_OS_TimeBaseCreate(void) { /* * Test Case For: - * int32 OS_TimeBaseCreate(uint32 *timer_id, const char *timebase_name, OS_TimerSync_t external_sync) + * int32 OS_TimeBaseCreate(osal_id_t *timebase_id, const char *timebase_name, OS_TimerSync_t external_sync) */ osal_id_t objid; @@ -103,7 +103,7 @@ void Test_OS_TimeBaseSet(void) { /* * Test Case For: - * int32 OS_TimeBaseSet(uint32 timer_id, uint32 start_time, uint32 interval_time) + * int32 OS_TimeBaseSet(osal_id_t timebase_id, uint32 start_time, uint32 interval_time) */ OSAPI_TEST_FUNCTION_RC(OS_TimeBaseSet(UT_OBJID_1, 1000, 1000), OS_SUCCESS); @@ -126,7 +126,7 @@ void Test_OS_TimeBaseDelete(void) { /* * Test Case For: - * int32 OS_TimeBaseDelete(uint32 timer_id) + * int32 OS_TimeBaseDelete(osal_id_t timebase_id) */ OSAPI_TEST_FUNCTION_RC(OS_TimeBaseDelete(UT_OBJID_1), OS_SUCCESS); @@ -142,7 +142,7 @@ void Test_OS_TimeBaseGetIdByName(void) { /* * Test Case For: - * int32 OS_TimeBaseGetIdByName (uint32 *timer_id, const char *timebase_name) + * int32 OS_TimeBaseGetIdByName(osal_id_t *timebase_id, const char *timebase_name) */ osal_id_t objid = OS_OBJECT_ID_UNDEFINED; diff --git a/src/unit-test-coverage/vxworks/src/coveragetest-idmap.c b/src/unit-test-coverage/vxworks/src/coveragetest-idmap.c index 31edfd31f..688051fe7 100644 --- a/src/unit-test-coverage/vxworks/src/coveragetest-idmap.c +++ b/src/unit-test-coverage/vxworks/src/coveragetest-idmap.c @@ -88,7 +88,7 @@ void Test_OS_WaitForStateChange_Impl(void) { /* * Test Case For: - * void OS_WaitForStateChange_Impl(osal_objtype_t idtype, uint32 attempts) + * void OS_WaitForStateChange_Impl(osal_objtype_t objtype, uint32 attempts) */ /* diff --git a/src/unit-test-coverage/vxworks/src/coveragetest-symtab.c b/src/unit-test-coverage/vxworks/src/coveragetest-symtab.c index b181c9147..4da5f8c43 100644 --- a/src/unit-test-coverage/vxworks/src/coveragetest-symtab.c +++ b/src/unit-test-coverage/vxworks/src/coveragetest-symtab.c @@ -98,7 +98,7 @@ static int32 UT_symEachHook(void *UserObj, int32 StubRetcode, uint32 CallCount, void Test_OS_SymbolTableDump_Impl(void) { /* Test Case For: - * int32 OS_SymbolTableDump_Impl ( const char *filename, uint32 SizeLimit ) + * int32 OS_SymbolTableDump_Impl(const char *filename, uint32 size_limit) */ /* With no action in symEach(), this will yield an empty file, which is an error */ diff --git a/src/unit-test-coverage/vxworks/src/coveragetest-timebase.c b/src/unit-test-coverage/vxworks/src/coveragetest-timebase.c index e04c70805..7c5f59b8f 100644 --- a/src/unit-test-coverage/vxworks/src/coveragetest-timebase.c +++ b/src/unit-test-coverage/vxworks/src/coveragetest-timebase.c @@ -253,7 +253,7 @@ void Test_OS_TimeBaseSet_Impl(void) void Test_OS_TimeBaseDelete_Impl(void) { /* Test Case For: - * int32 OS_TimeBaseDelete_Impl(uint32 timer_id) + * int32 OS_TimeBaseDelete_Impl(osal_id_t timebase_id) */ OS_object_token_t token = UT_TOKEN_0; diff --git a/src/unit-tests/osfile-test/ut_osfile_fileio_test.c b/src/unit-tests/osfile-test/ut_osfile_fileio_test.c index e11baed56..9a8050228 100644 --- a/src/unit-tests/osfile-test/ut_osfile_fileio_test.c +++ b/src/unit-tests/osfile-test/ut_osfile_fileio_test.c @@ -1024,10 +1024,10 @@ void UT_os_removefile_test() } /*--------------------------------------------------------------------------------* -** Syntax: int32 OS_rename(const char *old, const char *new) +** Syntax: int32 OS_rename(const char *old_filename, const char *new_filename) ** Purpose: Renames the given file name to the new file name -** Parameters: *old - pointer to the path/name of the file to be renamed -** *new - pointer to the new path/name of the file +** Parameters: *old_filename - pointer to the path/name of the file to be renamed +** *new_filename - pointer to the new path/name of the file ** Returns: OS_INVALID_POINTER if any of the pointers passed in is null ** OS_FS_ERR_PATH_TOO_LONG if the path name is too long ** OS_FS_ERR_NAME_TOO_LONG if the name is too long diff --git a/src/unit-tests/ostimer-test/ut_ostimer_timerio_test.c b/src/unit-tests/ostimer-test/ut_ostimer_timerio_test.c index c52c87ac8..a6bea2528 100644 --- a/src/unit-tests/ostimer-test/ut_ostimer_timerio_test.c +++ b/src/unit-tests/ostimer-test/ut_ostimer_timerio_test.c @@ -94,7 +94,7 @@ void UT_os_reconftimercallback(osal_id_t timerId, void *arg) } /*--------------------------------------------------------------------------------* -** Syntax: int32 OS_TimerCreate(uint32 *timer_id, const char *timer_name, uint32 *clock_accuracy, OS_TimerCallback_t +** Syntax: int32 OS_TimerCreate(osal_id_t *timer_id, const char *timer_name, uint32 *clock_accuracy, OS_TimerCallback_t *callback_ptr) ** Purpose: Creates a new timer and associates it with a callback routine ** Parameters: *timer_id - a pointer that will hold the timer id