diff options
Diffstat (limited to 'include/odp')
25 files changed, 26 insertions, 51 deletions
diff --git a/include/odp/api/spec/align.h b/include/odp/api/spec/align.h index 7fe8b2b20..6e4ef0cd2 100644 --- a/include/odp/api/spec/align.h +++ b/include/odp/api/spec/align.h @@ -4,7 +4,6 @@ * SPDX-License-Identifier: BSD-3-Clause */ - /** * @file * diff --git a/include/odp/api/spec/buffer.h b/include/odp/api/spec/buffer.h index 9e38854af..5ebf0ab25 100644 --- a/include/odp/api/spec/buffer.h +++ b/include/odp/api/spec/buffer.h @@ -4,7 +4,6 @@ * SPDX-License-Identifier: BSD-3-Clause */ - /** * @file * diff --git a/include/odp/api/spec/comp.h b/include/odp/api/spec/comp.h index e02719193..73c4bb9fc 100644 --- a/include/odp/api/spec/comp.h +++ b/include/odp/api/spec/comp.h @@ -197,7 +197,6 @@ typedef struct odp_comp_hash_alg_capability_t { * Compression algorithm capabilities */ typedef struct odp_comp_alg_capability_t { - /** Maximum compression level supported by implementation of this * algorithm. Indicates number of compression levels supported by * implementation. Valid range from (1 ... max_level) @@ -248,10 +247,10 @@ typedef struct odp_comp_deflate_param { * level supported by the implementation. * * where, - * 0 - implemention default + * 0 - implementation default * - * 1 - fastest compression i.e. output produced at - * best possible speed at the expense of compression quality + * 1 - fastest compression i.e. output produced at + * best possible speed at the expense of compression quality * * max_level - High quality compression * @@ -456,12 +455,12 @@ int odp_comp_session_destroy(odp_comp_session_t session); /** * Synchronous packet compression operation * - * This operation does packet compression in synchronous mode. A successful operation - * returns the number of successfully processed input packets and updates the - * results in the corresponding output packets. Outputted packets contain - * compression results metadata (odp_comp_packet_result_t), which should be - * checked for operation status. Length of outputted data can be got from - * output_data_range.len. + * This operation does packet compression in synchronous mode. A successful + * operation returns the number of successfully processed input packets and + * updates the results in the corresponding output packets. Outputted packets + * contain compression results metadata (odp_comp_packet_result_t), which + * should be checked for operation status. Length of outputted data can be got + * from output_data_range.len. * * When hashing is configured along with compression operation the * result is appended at the end of the output data, output_data_range.len diff --git a/include/odp/api/spec/cpu.h b/include/odp/api/spec/cpu.h index f6a7e656b..31e31fc54 100644 --- a/include/odp/api/spec/cpu.h +++ b/include/odp/api/spec/cpu.h @@ -4,7 +4,6 @@ * SPDX-License-Identifier: BSD-3-Clause */ - /** * @file * @@ -25,7 +24,6 @@ extern "C" { * @{ */ - /** * CPU identifier * diff --git a/include/odp/api/spec/cpumask.h b/include/odp/api/spec/cpumask.h index d2fe719c4..a78fddbfa 100644 --- a/include/odp/api/spec/cpumask.h +++ b/include/odp/api/spec/cpumask.h @@ -4,7 +4,6 @@ * SPDX-License-Identifier: BSD-3-Clause */ - /** * @file * diff --git a/include/odp/api/spec/crypto.h b/include/odp/api/spec/crypto.h index cfb2bc42c..c57873abe 100644 --- a/include/odp/api/spec/crypto.h +++ b/include/odp/api/spec/crypto.h @@ -4,7 +4,6 @@ * SPDX-License-Identifier: BSD-3-Clause */ - /** * @file * diff --git a/include/odp/api/spec/event.h b/include/odp/api/spec/event.h index 162fd5a72..ec57193a8 100644 --- a/include/odp/api/spec/event.h +++ b/include/odp/api/spec/event.h @@ -4,7 +4,6 @@ * SPDX-License-Identifier: BSD-3-Clause */ - /** * @file * diff --git a/include/odp/api/spec/hints.h b/include/odp/api/spec/hints.h index 816dcf3b3..48a0f9a95 100644 --- a/include/odp/api/spec/hints.h +++ b/include/odp/api/spec/hints.h @@ -4,7 +4,6 @@ * SPDX-License-Identifier: BSD-3-Clause */ - /** * @file * @@ -66,12 +65,11 @@ extern "C" { */ #define odp_unlikely(x) __builtin_expect((x), 0) - /* * __builtin_prefetch (const void *addr, rw, locality) * * rw 0..1 (0: read, 1: write) - * locality 0..3 (0: dont leave to cache, 3: leave on all cache levels) + * locality 0..3 (0: don't leave to cache, 3: leave on all cache levels) */ /** @@ -84,8 +82,6 @@ extern "C" { */ #define odp_prefetch_store(x) __builtin_prefetch((x), 1, 3) - - #else #define ODP_WEAK_SYMBOL @@ -99,7 +95,6 @@ extern "C" { #endif - /** * @} */ diff --git a/include/odp/api/spec/init.h b/include/odp/api/spec/init.h index c37af464d..70249d138 100644 --- a/include/odp/api/spec/init.h +++ b/include/odp/api/spec/init.h @@ -4,7 +4,6 @@ * SPDX-License-Identifier: BSD-3-Clause */ - /** * @file * @@ -232,7 +231,6 @@ void odp_init_param_init(odp_init_t *param); * passing any required platform specific data. */ - /** * Global ODP initialization * @@ -288,7 +286,7 @@ int odp_init_global(odp_instance_t *instance, * @retval <0 on failure * * @warning The unwinding of HW resources to allow them to be reused without - * reseting the device is a complex task that the application is expected to + * resetting the device is a complex task that the application is expected to * coordinate. This api may have platform dependent implications. * * @see odp_init_global() @@ -328,7 +326,7 @@ int odp_init_local(odp_instance_t instance, odp_thread_type_t thr_type); * @retval <0 on failure * * @warning The unwinding of HW resources to allow them to be reused without - * reseting the device is a complex task that the application is expected + * resetting the device is a complex task that the application is expected * to coordinate. * * @see odp_init_local() diff --git a/include/odp/api/spec/packet.h b/include/odp/api/spec/packet.h index 3fd571a38..91eb6c652 100644 --- a/include/odp/api/spec/packet.h +++ b/include/odp/api/spec/packet.h @@ -4,7 +4,6 @@ * SPDX-License-Identifier: BSD-3-Clause */ - /** * @file * diff --git a/include/odp/api/spec/packet_flags.h b/include/odp/api/spec/packet_flags.h index 500ecc148..0e4243968 100644 --- a/include/odp/api/spec/packet_flags.h +++ b/include/odp/api/spec/packet_flags.h @@ -4,7 +4,6 @@ * SPDX-License-Identifier: BSD-3-Clause */ - /** * @file * diff --git a/include/odp/api/spec/packet_io.h b/include/odp/api/spec/packet_io.h index d3e1d405f..5d5ca2bc4 100644 --- a/include/odp/api/spec/packet_io.h +++ b/include/odp/api/spec/packet_io.h @@ -4,7 +4,6 @@ * SPDX-License-Identifier: BSD-3-Clause */ - /** * @file * @@ -1224,10 +1223,18 @@ int odp_pktio_link_status(odp_pktio_t pktio); * Packet IO information */ typedef struct odp_pktio_info_t { - const char *name; /**< Packet IO device name */ - const char *drv_name; /**< Packet IO driver name (implementation specific) */ - odp_pool_t pool; /**< Packet pool */ - odp_pktio_param_t param; /**< Packet IO parameters */ + /** Packet IO device name */ + const char *name; + + /** Packet IO driver name (implementation specific) */ + const char *drv_name; + + /** Packet pool */ + odp_pool_t pool; + + /** Packet IO parameters */ + odp_pktio_param_t param; + } odp_pktio_info_t; /** diff --git a/include/odp/api/spec/packet_io_stats.h b/include/odp/api/spec/packet_io_stats.h index a412c153d..ea41e3a3a 100644 --- a/include/odp/api/spec/packet_io_stats.h +++ b/include/odp/api/spec/packet_io_stats.h @@ -56,8 +56,8 @@ typedef struct odp_pktio_stats_t { uint64_t in_discards; /** - * The sum for this interface of AlignmentErrors, FCSErrors, FrameTooLongs, - * InternalMacReceiveErrors. See ifInErrors in RFC 3635. + * The sum for this interface of AlignmentErrors, FCSErrors, + * FrameTooLongs, InternalMacReceiveErrors. See ifInErrors in RFC 3635. */ uint64_t in_errors; diff --git a/include/odp/api/spec/pool.h b/include/odp/api/spec/pool.h index e6cd77c9a..d4cf088f1 100644 --- a/include/odp/api/spec/pool.h +++ b/include/odp/api/spec/pool.h @@ -4,7 +4,6 @@ * SPDX-License-Identifier: BSD-3-Clause */ - /** * @file * diff --git a/include/odp/api/spec/queue.h b/include/odp/api/spec/queue.h index 2f5e1230f..605831c50 100644 --- a/include/odp/api/spec/queue.h +++ b/include/odp/api/spec/queue.h @@ -4,7 +4,6 @@ * SPDX-License-Identifier: BSD-3-Clause */ - /** * @file * diff --git a/include/odp/api/spec/random.h b/include/odp/api/spec/random.h index 11bf33025..516de536f 100644 --- a/include/odp/api/spec/random.h +++ b/include/odp/api/spec/random.h @@ -4,7 +4,6 @@ * SPDX-License-Identifier: BSD-3-Clause */ - /** * @file * diff --git a/include/odp/api/spec/rwlock.h b/include/odp/api/spec/rwlock.h index 7924a50a7..a5b1e48a1 100644 --- a/include/odp/api/spec/rwlock.h +++ b/include/odp/api/spec/rwlock.h @@ -36,7 +36,6 @@ extern "C" { * ODP reader/writer lock */ - /** * Initialize a reader/writer lock. * diff --git a/include/odp/api/spec/schedule.h b/include/odp/api/spec/schedule.h index fa66f2600..8591dda3f 100644 --- a/include/odp/api/spec/schedule.h +++ b/include/odp/api/spec/schedule.h @@ -4,7 +4,6 @@ * SPDX-License-Identifier: BSD-3-Clause */ - /** * @file * diff --git a/include/odp/api/spec/shared_memory.h b/include/odp/api/spec/shared_memory.h index c18275cb1..05c8de401 100644 --- a/include/odp/api/spec/shared_memory.h +++ b/include/odp/api/spec/shared_memory.h @@ -4,7 +4,6 @@ * SPDX-License-Identifier: BSD-3-Clause */ - /** * @file * diff --git a/include/odp/api/spec/std_types.h b/include/odp/api/spec/std_types.h index 083523a30..45753e819 100644 --- a/include/odp/api/spec/std_types.h +++ b/include/odp/api/spec/std_types.h @@ -4,7 +4,6 @@ * SPDX-License-Identifier: BSD-3-Clause */ - /** * @file * diff --git a/include/odp/api/spec/system_info.h b/include/odp/api/spec/system_info.h index e7fb570fa..aebd3dfc6 100644 --- a/include/odp/api/spec/system_info.h +++ b/include/odp/api/spec/system_info.h @@ -4,7 +4,6 @@ * SPDX-License-Identifier: BSD-3-Clause */ - /** * @file * diff --git a/include/odp/api/spec/thread.h b/include/odp/api/spec/thread.h index 54d4a00e3..de6d78fb1 100644 --- a/include/odp/api/spec/thread.h +++ b/include/odp/api/spec/thread.h @@ -4,7 +4,6 @@ * SPDX-License-Identifier: BSD-3-Clause */ - /** * @file * @@ -73,7 +72,6 @@ int odp_thread_count_max(void); */ odp_thread_type_t odp_thread_type(void); - /** * @} */ diff --git a/include/odp/api/spec/ticketlock.h b/include/odp/api/spec/ticketlock.h index fd42355be..0d5d67a88 100644 --- a/include/odp/api/spec/ticketlock.h +++ b/include/odp/api/spec/ticketlock.h @@ -4,7 +4,6 @@ * SPDX-License-Identifier: BSD-3-Clause */ - /** * @file * @@ -44,7 +43,6 @@ extern "C" { */ void odp_ticketlock_init(odp_ticketlock_t *tklock); - /** * Acquire ticket lock. * @@ -69,7 +67,6 @@ int odp_ticketlock_trylock(odp_ticketlock_t *tklock); */ void odp_ticketlock_unlock(odp_ticketlock_t *tklock); - /** * Check if ticket lock is locked. * diff --git a/include/odp/api/spec/time.h b/include/odp/api/spec/time.h index dd49feefd..f79f4a8ac 100644 --- a/include/odp/api/spec/time.h +++ b/include/odp/api/spec/time.h @@ -4,7 +4,6 @@ * SPDX-License-Identifier: BSD-3-Clause */ - /** * @file * diff --git a/include/odp/api/spec/timer.h b/include/odp/api/spec/timer.h index c5c85514f..ee314914f 100644 --- a/include/odp/api/spec/timer.h +++ b/include/odp/api/spec/timer.h @@ -4,7 +4,6 @@ * SPDX-License-Identifier: BSD-3-Clause */ - /** * @file * |