diff --git a/doc/doxygen/Doxyfile.in b/doc/doxygen/Doxyfile.in index 54ee23933e6766ad83d887bc7fa91c33451cdfdd..db87bbce609a45053cb87b1a1a9a8c5488cfbc04 100644 --- a/doc/doxygen/Doxyfile.in +++ b/doc/doxygen/Doxyfile.in @@ -485,7 +485,7 @@ LOOKUP_CACHE_SIZE = 0 # DOT_NUM_THREADS setting. # Minimum value: 0, maximum value: 32, default value: 1. -NUM_PROC_THREADS = 0 +NUM_PROC_THREADS = 1 #--------------------------------------------------------------------------- # Build related configuration options @@ -912,9 +912,9 @@ INPUT = @SRCDIR@/lib \ @SRCDIR@/README.md \ @SRCDIR@/INSTALL.md \ @SRCDIR@/how_to_no_header.md \ - @SRCDIR@/include \ @SRCDIR@/test \ - @SRCDIR@/cmp_tool.c + @SRCDIR@/programs \ + @SRCDIR@/examples # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses @@ -1385,14 +1385,6 @@ HTML_COLORSTYLE_SAT = 255 HTML_COLORSTYLE_GAMMA = 113 -# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML -# page will contain the date and time when the page was generated. Setting this -# to YES can help to show when doxygen was last run and thus if the -# documentation is up to date. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_TIMESTAMP = NO # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML # documentation will contain a main index with vertical navigation menus that @@ -2054,14 +2046,6 @@ LATEX_HIDE_INDICES = NO LATEX_BIB_STYLE = plain -# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated -# page will contain the date and time when the page was generated. Setting this -# to NO can help when comparing the output of multiple runs. -# The default value is: NO. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -LATEX_TIMESTAMP = NO - # The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute) # path from which the emoji images will be read. If a relative path is entered, # it will be relative to the LATEX_OUTPUT directory. If left blank the @@ -2289,7 +2273,7 @@ ENABLE_PREPROCESSING = YES # The default value is: NO. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. -MACRO_EXPANSION = NO +MACRO_EXPANSION = YES # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then # the macro expansion is limited to the macros specified with the PREDEFINED and @@ -2297,7 +2281,7 @@ MACRO_EXPANSION = NO # The default value is: NO. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. -EXPAND_ONLY_PREDEF = NO +EXPAND_ONLY_PREDEF = YES # If the SEARCH_INCLUDES tag is set to YES, the include files in the # INCLUDE_PATH will be searched if a #include is found. @@ -2330,7 +2314,9 @@ INCLUDE_FILE_PATTERNS = # recursively expanded use the := operator instead of the = operator. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. -PREDEFINED = +PREDEFINED = __attribute__((packed))= \ + UNUSED= \ + MAYBE_UNUSED= # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this # tag can be used to specify a list of macro names that should be expanded. The diff --git a/lib/cmp_chunk.h b/lib/cmp_chunk.h index d56afe15761e97bfbaeacaf60cf044c16a74d923..2300483ae52b18a03a4a33c3e55f93b0eb16078e 100644 --- a/lib/cmp_chunk.h +++ b/lib/cmp_chunk.h @@ -144,7 +144,7 @@ uint32_t compress_chunk_cmp_size_bound(const void *chunk, size_t chunk_size); * @param version_id application software version identifier */ -void compress_chunk_init(uint64_t(return_timestamp)(void), uint32_t version_id); +void compress_chunk_init(uint64_t (*return_timestamp)(void), uint32_t version_id); /** @@ -170,6 +170,7 @@ void compress_chunk_init(uint64_t(return_timestamp)(void), uint32_t version_id); * not enough space in the dst buffer to write the * compressed data; size is internally rounded down * to a multiple of 4 + * @param cmp_par pointer to a compression parameters struct * @returns the byte size of the compressed data or an error code if it * fails (which can be tested with cmp_is_error()) */ diff --git a/lib/common/cmp_entity.c b/lib/common/cmp_entity.c index f1819714e52c761bb75122d7e961c85784584c32..b0644bad59ba93272d8a681bc3fa48a5d0d100c9 100644 --- a/lib/common/cmp_entity.c +++ b/lib/common/cmp_entity.c @@ -538,7 +538,7 @@ int cmp_ent_set_ima_golomb_par(struct cmp_entity *ent, uint32_t golomb_par_used) } -/* +/** * @brief set the used adaptive 1 spillover threshold parameter in the adaptive * imagette specific compression entity header * @@ -588,7 +588,7 @@ int cmp_ent_set_ima_ap1_golomb_par(struct cmp_entity *ent, uint32_t ap1_golomb_p } -/* +/** * @brief set the used adaptive 2 spillover threshold parameter in the adaptive * imagette specific compression entity header * @@ -638,7 +638,7 @@ int cmp_ent_set_ima_ap2_golomb_par(struct cmp_entity *ent, uint32_t ap2_golomb_p } -/* +/** * @brief set the used spillover threshold 1 parameter in the non-imagette * specific compression entity header * @@ -691,7 +691,7 @@ int cmp_ent_set_non_ima_cmp_par1(struct cmp_entity *ent, uint32_t cmp_par_1_used } -/* +/** * @brief set the used spillover threshold 2 parameter in the non-imagette * specific compression entity header * @@ -744,7 +744,7 @@ int cmp_ent_set_non_ima_cmp_par2(struct cmp_entity *ent, uint32_t cmp_par_2_used } -/* +/** * @brief set the used spillover threshold 3 parameter in the non-imagette * specific compression entity header * @@ -797,7 +797,7 @@ int cmp_ent_set_non_ima_cmp_par3(struct cmp_entity *ent, uint32_t cmp_par_3_used } -/* +/** * @brief set the used spillover threshold 4 parameter in the non-imagette * specific compression entity header * @@ -850,7 +850,7 @@ int cmp_ent_set_non_ima_cmp_par4(struct cmp_entity *ent, uint32_t cmp_par_4_used } -/* +/** * @brief set the used spillover threshold 5 parameter in the non-imagette * specific compression entity header * @@ -903,7 +903,7 @@ int cmp_ent_set_non_ima_cmp_par5(struct cmp_entity *ent, uint32_t cmp_par_5_used } -/* +/** * @brief set the used spillover threshold 6 parameter in the non-imagette * specific compression entity header * @@ -1895,7 +1895,7 @@ uint32_t cmp_ent_create(struct cmp_entity *ent, enum cmp_data_type data_type, #ifdef HAS_TIME_H -/* +/** * @brief Convert a calendar time expressed as a struct tm object to time since * epoch as a time_t object. The function interprets the input structure * as representing Universal Coordinated Time (UTC). @@ -1939,7 +1939,7 @@ static time_t my_timegm(struct tm *tm) #ifdef HAS_TIME_H -/* +/** * @brief Generate a timestamp for the compression header * * @param ts pointer to an object of type struct timespec of the diff --git a/lib/common/cmp_support.h b/lib/common/cmp_support.h index ea2acf20d2881d7ffdea1acb07ce94a4901a6dd0..c5043365903eeab356e28cdb4e406a85d931ca9e 100644 --- a/lib/common/cmp_support.h +++ b/lib/common/cmp_support.h @@ -123,15 +123,16 @@ enum cmp_data_type { /** - * @brief defined compression mode + * @brief compression modes + * This enum defines the various compression modes available */ enum cmp_mode { - CMP_MODE_RAW, - CMP_MODE_MODEL_ZERO, - CMP_MODE_DIFF_ZERO, - CMP_MODE_MODEL_MULTI, - CMP_MODE_DIFF_MULTI + CMP_MODE_RAW, /**< raw compression mode */ + CMP_MODE_MODEL_ZERO, /**< model compression mode with zero escape symbol mechanism */ + CMP_MODE_DIFF_ZERO, /**< 1-D differential compression mode with zero escape symbol mechanism */ + CMP_MODE_MODEL_MULTI, /**< model compression mode with multi escape symbol mechanism */ + CMP_MODE_DIFF_MULTI /**< 1-D differential multi compression mode with multi escape symbol mechanism*/ }; diff --git a/lib/common/vsnprintf.c b/lib/common/vsnprintf.c index 87a75e1f7fd8fd1526ae7144a9c040c4a5620c95..538c69684f2c03df2bd5910c2d0bc6a6ee1a5c68 100644 --- a/lib/common/vsnprintf.c +++ b/lib/common/vsnprintf.c @@ -1,4 +1,4 @@ -/* +/** * @author (c) Marco Paland (info@paland.com) * 2014-2019, PALANDesign Hannover, Germany * diff --git a/lib/icu_compress/cmp_icu.c b/lib/icu_compress/cmp_icu.c index 74a9fa27b943dd906744150271677b7a7d2c7843..ab3d7df3dd08470af265c35cb9aeea99fb5ab002 100644 --- a/lib/icu_compress/cmp_icu.c +++ b/lib/icu_compress/cmp_icu.c @@ -275,9 +275,8 @@ static uint32_t golomb_encoder(uint32_t value, uint32_t m, uint32_t log2_m, * @param stream_len length of the bitstream in bits * @param setup pointer to the encoder setup * - * @returns the bit length of the bitstream with the added encoded value on - * success; negative on error, CMP_ERROR_SMALL_BUF if the bitstream buffer - * is too small to put the value in the bitstream + * @returns the bit length of the bitstream on success or an error code if it + * fails (which can be tested with cmp_is_error()) */ static uint32_t encode_normal(uint32_t value, uint32_t stream_len, @@ -302,9 +301,8 @@ static uint32_t encode_normal(uint32_t value, uint32_t stream_len, * @param stream_len length of the bitstream in bits * @param setup pointer to the encoder setup * - * @returns the bit length of the bitstream with the added encoded value on - * success; negative on error, CMP_ERROR_SMALL_BUF if the bitstream buffer - * is too small to put the value in the bitstream + * @returns the bit length of the bitstream on success or an error code if it + * fails (which can be tested with cmp_is_error()) * * @note no check if the data or model are in the allowed range * @note no check if the setup->spillover_par is in the allowed range @@ -351,9 +349,8 @@ static uint32_t encode_value_zero(uint32_t data, uint32_t model, uint32_t stream * @param stream_len length of the bitstream in bits * @param setup pointer to the encoder setup * - * @returns the bit length of the bitstream with the added encoded value on - * success; negative on error, CMP_ERROR_SMALL_BUF if the bitstream buffer - * is too small to put the value in the bitstream + * @returns the bit length of the bitstream on success or an error code if it + * fails (which can be tested with cmp_is_error()) * * @note no check if the data or model are in the allowed range * @note no check if the setup->spillover_par is in the allowed range @@ -415,10 +412,8 @@ static uint32_t encode_value_multi(uint32_t data, uint32_t model, uint32_t strea * @param stream_len length of the bitstream in bits * @param setup pointer to the encoder setup * - * @returns the bit length of the bitstream with the added encoded value on - * success; negative on error, CMP_ERROR_SMALL_BUF if the bitstream buffer - * is too small to put the value in the bitstream, CMP_ERROR_HIGH_VALUE if - * the value or the model is bigger than the max_used_bits parameter allows + * @returns the bit length of the bitstream on success or an error code if it + * fails (which can be tested with cmp_is_error()) */ static uint32_t encode_value(uint32_t data, uint32_t model, uint32_t stream_len, @@ -498,12 +493,11 @@ static void configure_encoder_setup(struct encoder_setup *setup, /** * @brief compress imagette data * - * @param cfg pointer to the compression configuration structure + * @param cfg pointer to the compression configuration structure + * @param stream_len already used length of the bitstream in bits * - * @returns the bit length of the bitstream on success; negative on error, - * CMP_ERROR_SMALL_BUF if the bitstream buffer is too small to put the - * value in the bitstream, CMP_ERROR_HIGH_VALUE if the value or the model is - * bigger than the max_used_bits parameter allows + * @returns the bit length of the bitstream on success or an error code if it + * fails (which can be tested with cmp_is_error()) */ static uint32_t compress_imagette(const struct cmp_cfg *cfg, uint32_t stream_len) @@ -560,11 +554,11 @@ static uint32_t compress_imagette(const struct cmp_cfg *cfg, uint32_t stream_len /** * @brief compress short normal light flux (S_FX) data * - * @param cfg pointer to the compression configuration structure + * @param cfg pointer to the compression configuration structure + * @param stream_len already used length of the bitstream in bits * - * @returns the bit length of the bitstream on success; negative on error, - * CMP_ERROR_SMALL_BUF if the bitstream buffer is too small to put the - * value in the bitstream + * @returns the bit length of the bitstream on success or an error code if it + * fails (which can be tested with cmp_is_error()) */ static uint32_t compress_s_fx(const struct cmp_cfg *cfg, uint32_t stream_len) @@ -621,11 +615,11 @@ static uint32_t compress_s_fx(const struct cmp_cfg *cfg, uint32_t stream_len) /** * @brief compress S_FX_EFX data * - * @param cfg pointer to the compression configuration structure + * @param cfg pointer to the compression configuration structure + * @param stream_len already used length of the bitstream in bits * - * @returns the bit length of the bitstream on success; negative on error, - * CMP_ERROR_SMALL_BUF if the bitstream buffer is too small to put the - * value in the bitstream + * @returns the bit length of the bitstream on success or an error code if it + * fails (which can be tested with cmp_is_error()) */ static uint32_t compress_s_fx_efx(const struct cmp_cfg *cfg, uint32_t stream_len) @@ -690,11 +684,11 @@ static uint32_t compress_s_fx_efx(const struct cmp_cfg *cfg, uint32_t stream_len /** * @brief compress S_FX_NCOB data * - * @param cfg pointer to the compression configuration structure + * @param cfg pointer to the compression configuration structure + * @param stream_len already used length of the bitstream in bits * - * @returns the bit length of the bitstream on success; negative on error, - * CMP_ERROR_SMALL_BUF if the bitstream buffer is too small to put the - * value in the bitstream + * @returns the bit length of the bitstream on success or an error code if it + * fails (which can be tested with cmp_is_error()) */ static uint32_t compress_s_fx_ncob(const struct cmp_cfg *cfg, uint32_t stream_len) @@ -765,11 +759,11 @@ static uint32_t compress_s_fx_ncob(const struct cmp_cfg *cfg, uint32_t stream_le /** * @brief compress S_FX_EFX_NCOB_ECOB data * - * @param cfg pointer to the compression configuration structure + * @param cfg pointer to the compression configuration structure + * @param stream_len already used length of the bitstream in bits * - * @returns the bit length of the bitstream on success; negative on error, - * CMP_ERROR_SMALL_BUF if the bitstream buffer is too small to put the - * value in the bitstream + * @returns the bit length of the bitstream on success or an error code if it + * fails (which can be tested with cmp_is_error()) */ static uint32_t compress_s_fx_efx_ncob_ecob(const struct cmp_cfg *cfg, uint32_t stream_len) @@ -863,11 +857,11 @@ static uint32_t compress_s_fx_efx_ncob_ecob(const struct cmp_cfg *cfg, uint32_t /** * @brief compress L_FX data * - * @param cfg pointer to the compression configuration structure + * @param cfg pointer to the compression configuration structure + * @param stream_len already used length of the bitstream in bits * - * @returns the bit length of the bitstream on success; negative on error, - * CMP_ERROR_SMALL_BUF if the bitstream buffer is too small to put the - * value in the bitstream + * @returns the bit length of the bitstream on success or an error code if it + * fails (which can be tested with cmp_is_error()) */ static uint32_t compress_l_fx(const struct cmp_cfg *cfg, uint32_t stream_len) @@ -932,11 +926,11 @@ static uint32_t compress_l_fx(const struct cmp_cfg *cfg, uint32_t stream_len) /** * @brief compress L_FX_EFX data * - * @param cfg pointer to the compression configuration structure + * @param cfg pointer to the compression configuration structure + * @param stream_len already used length of the bitstream in bits * - * @returns the bit length of the bitstream on success; negative on error, - * CMP_ERROR_SMALL_BUF if the bitstream buffer is too small to put the - * value in the bitstream + * @returns the bit length of the bitstream on success or an error code if it + * fails (which can be tested with cmp_is_error()) */ static uint32_t compress_l_fx_efx(const struct cmp_cfg *cfg, uint32_t stream_len) @@ -1009,11 +1003,11 @@ static uint32_t compress_l_fx_efx(const struct cmp_cfg *cfg, uint32_t stream_len /** * @brief compress L_FX_NCOB data * - * @param cfg pointer to the compression configuration structure + * @param cfg pointer to the compression configuration structure + * @param stream_len already used length of the bitstream in bits * - * @returns the bit length of the bitstream on success; negative on error, - * CMP_ERROR_SMALL_BUF if the bitstream buffer is too small to put the - * value in the bitstream + * @returns the bit length of the bitstream on success or an error code if it + * fails (which can be tested with cmp_is_error()) */ static uint32_t compress_l_fx_ncob(const struct cmp_cfg *cfg, uint32_t stream_len) @@ -1108,11 +1102,11 @@ static uint32_t compress_l_fx_ncob(const struct cmp_cfg *cfg, uint32_t stream_le /** * @brief compress L_FX_EFX_NCOB_ECOB data * - * @param cfg pointer to the compression configuration structure + * @param cfg pointer to the compression configuration structure + * @param stream_len already used length of the bitstream in bits * - * @returns the bit length of the bitstream on success; negative on error, - * CMP_ERROR_SMALL_BUF if the bitstream buffer is too small to put the - * value in the bitstream + * @returns the bit length of the bitstream on success or an error code if it + * fails (which can be tested with cmp_is_error()) */ static uint32_t compress_l_fx_efx_ncob_ecob(const struct cmp_cfg *cfg, uint32_t stream_len) @@ -1229,10 +1223,11 @@ static uint32_t compress_l_fx_efx_ncob_ecob(const struct cmp_cfg *cfg, uint32_t /** * @brief compress offset data from the normal and fast cameras * - * @param cfg pointer to the compression configuration structure - * @returns the bit length of the bitstream on success; negative on error, - * CMP_ERROR_SMALL_BUF if the bitstream buffer is too small to put the - * value in the bitstream + * @param cfg pointer to the compression configuration structure + * @param stream_len already used length of the bitstream in bits + * + * @returns the bit length of the bitstream on success or an error code if it + * fails (which can be tested with cmp_is_error()) */ static uint32_t compress_offset(const struct cmp_cfg *cfg, uint32_t stream_len) @@ -1301,10 +1296,11 @@ static uint32_t compress_offset(const struct cmp_cfg *cfg, uint32_t stream_len) /** * @brief compress background data from the normal and fast cameras * - * @param cfg pointer to the compression configuration structure - * @returns the bit length of the bitstream on success; negative on error, - * CMP_ERROR_SMALL_BUF if the bitstream buffer is too small to put the - * value in the bitstream + * @param cfg pointer to the compression configuration structure + * @param stream_len already used length of the bitstream in bits + * + * @returns the bit length of the bitstream on success or an error code if it + * fails (which can be tested with cmp_is_error()) */ static uint32_t compress_background(const struct cmp_cfg *cfg, uint32_t stream_len) @@ -1382,11 +1378,11 @@ static uint32_t compress_background(const struct cmp_cfg *cfg, uint32_t stream_l /** * @brief compress smearing data from the normal cameras * - * @param cfg pointer to the compression configuration structure + * @param cfg pointer to the compression configuration structure + * @param stream_len already used length of the bitstream in bits * - * @returns the bit length of the bitstream on success; negative on error, - * CMP_ERROR_SMALL_BUF if the bitstream buffer is too small to put the - * value in the bitstream + * @returns the bit length of the bitstream on success or an error code if it + * fails (which can be tested with cmp_is_error()) */ static uint32_t compress_smearing(const struct cmp_cfg *cfg, uint32_t stream_len) @@ -1554,9 +1550,8 @@ static uint32_t cmp_cfg_icu_is_invalid_error_code(const struct cmp_cfg *cfg) * @param cfg pointer to the compression configuration structure * @param cmp_size length of the bitstream in bits * - * @returns the bit length of the bitstream on success; negative on error, - * CMP_ERROR_SMALL_BUF if the bitstream buffer is too small to put the - * value in the bitstream + * @returns the bit length of the bitstream on success or an error code if it + * fails (which can be tested with cmp_is_error()) */ static uint32_t pad_bitstream(const struct cmp_cfg *cfg, uint32_t cmp_size) @@ -1588,10 +1583,10 @@ static uint32_t pad_bitstream(const struct cmp_cfg *cfg, uint32_t cmp_size) * This function can compress all types of collection data (one at a time). * This function does not take the header of a collection into account. * - * @param cfg pointer to a compression configuration + * @param cfg pointer to the compression configuration structure + * @param stream_len already used length of the bitstream in bits * - * @note the validity of the cfg structure is checked before the compression is - * started + * @note the validity of the cfg structure is not checked * * @returns the bit length of the bitstream on success or an error code if it * fails (which can be tested with cmp_is_error()) @@ -1810,7 +1805,7 @@ static uint32_t cmp_collection(const uint8_t *col, dst_size_bits = compress_data_internal(cfg, dst_size << 3); if (cmp_get_error_code(dst_size_bits) == CMP_ERROR_SMALL_BUFFER || - (!dst && dst_size_bits > cmp_stream_size_to_bits(cfg->stream_size))) { /* if dst == NULL compress_data_internal will not return a CMP_ERROR_SMALL_BUF */ + (!dst && dst_size_bits > cmp_stream_size_to_bits(cfg->stream_size))) { /* if dst == NULL compress_data_internal will not return a CMP_ERROR_SMALL_BUFFER */ /* can not compress the data with the given parameters; * put them uncompressed (raw) into the dst buffer */ enum cmp_mode cmp_mode_cpy = cfg->cmp_mode; @@ -2086,7 +2081,7 @@ static enum chunk_type init_cmp_cfg_from_cmp_par(const struct collection_hdr *co * @param version_id application software version identifier */ -void compress_chunk_init(uint64_t(return_timestamp)(void), uint32_t version_id) +void compress_chunk_init(uint64_t (*return_timestamp)(void), uint32_t version_id) { if (return_timestamp) get_timestamp = return_timestamp; @@ -2118,6 +2113,7 @@ void compress_chunk_init(uint64_t(return_timestamp)(void), uint32_t version_id) * not enough space in the dst buffer to write the * compressed data; size is internally rounded down * to a multiple of 4 + * @param cmp_par pointer to a compression parameters struct * @returns the byte size of the compressed data or an error code if it * fails (which can be tested with cmp_is_error()) */ diff --git a/lib/rdcu_compress/rmap.c b/lib/rdcu_compress/rmap.c index 1ef7811c43fab9a34ea8d6f9748d202548aa6de4..c713135a30b099c180dea5aaacc1e1bef247b08f 100644 --- a/lib/rdcu_compress/rmap.c +++ b/lib/rdcu_compress/rmap.c @@ -477,7 +477,7 @@ int rmap_build_hdr(struct rmap_pkt *pkt, uint8_t *hdr) * @brief create an rmap packet from a buffer * * @param buf the buffer, with the target path stripped away, i.e. - * starting with <logical address>, <protocol id>, ... + * starting with [logical address], [protocol id], ... * @param len the data length of the buffer (in bytes) * * @returns an rmap packet, containing the decoded buffer including any data, @@ -732,7 +732,7 @@ static void rmap_parse_reply_pkt(uint8_t *pkt) /** * parse an RMAP packet: * - * expected format: <logical address> <protocol id> ... + * expected format: [logical address] [protocol id] ... */ void rmap_parse_pkt(uint8_t *pkt) diff --git a/test/bench/leon3_grtimer.c b/test/bench/leon3_grtimer.c index a86d7823bc327dfd133c33434894301aebe97346..37e24284f08488676c59a7c2ffa8ac679b927753 100644 --- a/test/bench/leon3_grtimer.c +++ b/test/bench/leon3_grtimer.c @@ -32,7 +32,7 @@ /** * @brief set scaler reload value of the timer block * @param rtu a struct grtimer_unit - * + * @param value scaler reload value */ void grtimer_set_scaler_reload(struct grtimer_unit *rtu, uint32_t value) @@ -44,7 +44,6 @@ void grtimer_set_scaler_reload(struct grtimer_unit *rtu, uint32_t value) /** * @brief get scaler reload value of the timer block * @param rtu a struct grtimer_unit - * */ uint32_t grtimer_get_scaler_reload(struct grtimer_unit *rtu) diff --git a/test/bench/leon3_grtimer_longcount.c b/test/bench/leon3_grtimer_longcount.c index 2c95387b74bc4801bc06846279546ed389533d97..771c97e010b57f6e165a197547349eec13c55c59 100644 --- a/test/bench/leon3_grtimer_longcount.c +++ b/test/bench/leon3_grtimer_longcount.c @@ -120,12 +120,12 @@ void grtimer_longcount_get_uptime(struct grtimer_unit *rtu, /** - * @brief - * get the number of seconds elapsed between timestamps taken from the + * @brief get the number of seconds elapsed between timestamps taken from the * longcount timer * - * @bparam time1 a struct grtime_uptime - * @bparam time0 a struct grtime_uptime + * @param rtu a struct grtimer_unit + * @param time1 a struct grtime_uptime + * @param time0 a struct grtime_uptime * * @return time difference in seconds represented as double */ diff --git a/test/bench/leon_reg.h b/test/bench/leon_reg.h index 4bb0e5eb7b4d2de7bc8a84e09e68b2e5e9e58ab3..94ad2a7f95ab0ff2b03504c39e61753416d40536 100644 --- a/test/bench/leon_reg.h +++ b/test/bench/leon_reg.h @@ -1,5 +1,5 @@ /** - * @file leon/leon_reg.h + * @file leon_reg.h * * @author Armin Luntzer (armin.luntzer@univie.ac.at) * @date 2015 diff --git a/test/fuzz/fuzz_compression.c b/test/fuzz/fuzz_compression.c index 2817129848143929800c02ef13381733585152af..c0476546226b9fe472d01bcb802d874891376b55 100644 --- a/test/fuzz/fuzz_compression.c +++ b/test/fuzz/fuzz_compression.c @@ -1,5 +1,5 @@ /** - * @file fuzz_copression.c + * @file fuzz_compression.c * @date 2024 * * @copyright GPLv2 diff --git a/test/test_common/chunk_round_trip.c b/test/test_common/chunk_round_trip.c index 82a936c74f20587c82c8717959dee19824e11b1f..d0324d254803cecbd4ab478bec56e91307f1993c 100644 --- a/test/test_common/chunk_round_trip.c +++ b/test/test_common/chunk_round_trip.c @@ -59,6 +59,7 @@ * decompressed data * @param use_decmp_up_model if non-zero, a buffer for the updated model is * allocated during the decompression + * @param cmp_par pointer to a compression parameters struct * * @returns the return value of the compress_chunk() function */