From patchwork Tue Oct 21 21:12:11 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Anders Roxell X-Patchwork-Id: 39231 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-lb0-f200.google.com (mail-lb0-f200.google.com [209.85.217.200]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id 23BF9202DB for ; Tue, 21 Oct 2014 21:12:46 +0000 (UTC) Received: by mail-lb0-f200.google.com with SMTP id b6sf1314816lbj.3 for ; Tue, 21 Oct 2014 14:12:44 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:delivered-to:from:to:date:message-id:in-reply-to :references:subject:precedence:list-id:list-unsubscribe:list-archive :list-post:list-help:list-subscribe:mime-version:errors-to:sender :x-original-sender:x-original-authentication-results:mailing-list :content-type:content-transfer-encoding; bh=aqT/ipLg4b7I6YbhszFOxrspowSXcq/JlPu3F/OGjW0=; b=QvmRi4qR0zvBuH83O7dJ9qHAI5g6RdV7Hzy2tUc1T4CkEo9GjfriTZxx51Y5cUMiIw wt5CXvIeqTga7jbK+9XbcHgDOerxTOhFZooOxV3SNZHy5Apv380b+qmqfSdVgUms3Mx+ sr63xu32xABDyKNO2lk/TXEbFaySKXMZ4gr9fTEB7gtxviXSSrgZyVhv60O3+Z42Dgr0 x/9ouZf8F6R2rzei1PdjYpUQiKKK7PiD6avCGjpeMXwNu8/lMFJFzUEK3a5+qrX3h+ls ZtdALU8x9Rbj68NnUr0gc7Ch4Yd+CAPKrv2fpF8NhH3C599MBg6J3STKNrqZgt7pim/B 1JJg== X-Gm-Message-State: ALoCoQkg+D1CNJ28AwA6Q/gutuS4b6W2uBBKsHyYg4yrndbH+oA8yx1jwNoPCov7d63iYC/Yq4k5 X-Received: by 10.152.88.70 with SMTP id be6mr5602851lab.1.1413925964962; Tue, 21 Oct 2014 14:12:44 -0700 (PDT) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.170.227 with SMTP id ap3ls104218lac.31.gmail; Tue, 21 Oct 2014 14:12:44 -0700 (PDT) X-Received: by 10.152.22.135 with SMTP id d7mr37344010laf.46.1413925964811; Tue, 21 Oct 2014 14:12:44 -0700 (PDT) Received: from mail-la0-f51.google.com (mail-la0-f51.google.com. [209.85.215.51]) by mx.google.com with ESMTPS id yf4si20717044lbb.124.2014.10.21.14.12.44 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Tue, 21 Oct 2014 14:12:44 -0700 (PDT) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.215.51 as permitted sender) client-ip=209.85.215.51; Received: by mail-la0-f51.google.com with SMTP id ge10so1839213lab.38 for ; Tue, 21 Oct 2014 14:12:44 -0700 (PDT) X-Received: by 10.152.29.8 with SMTP id f8mr37536953lah.56.1413925964675; Tue, 21 Oct 2014 14:12:44 -0700 (PDT) X-Forwarded-To: patchwork-forward@linaro.org X-Forwarded-For: patch@linaro.org patchwork-forward@linaro.org Delivered-To: patch@linaro.org Received: by 10.112.84.229 with SMTP id c5csp582626lbz; Tue, 21 Oct 2014 14:12:43 -0700 (PDT) X-Received: by 10.224.79.211 with SMTP id q19mr17698558qak.101.1413925962186; Tue, 21 Oct 2014 14:12:42 -0700 (PDT) Received: from ip-10-35-177-41.ec2.internal (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTPS id c23si8084730qge.99.2014.10.21.14.12.38 for (version=TLSv1 cipher=RC4-SHA bits=128/128); Tue, 21 Oct 2014 14:12:42 -0700 (PDT) Received-SPF: none (google.com: lng-odp-bounces@lists.linaro.org does not designate permitted sender hosts) client-ip=54.225.227.206; Received: from localhost ([127.0.0.1] helo=ip-10-35-177-41.ec2.internal) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1XggjO-0007qN-3T; Tue, 21 Oct 2014 21:12:38 +0000 Received: from mail-la0-f46.google.com ([209.85.215.46]) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1XggjE-0007ob-5j for lng-odp@lists.linaro.org; Tue, 21 Oct 2014 21:12:28 +0000 Received: by mail-la0-f46.google.com with SMTP id gi9so1799178lab.19 for ; Tue, 21 Oct 2014 14:12:22 -0700 (PDT) X-Received: by 10.152.26.8 with SMTP id h8mr37508895lag.39.1413925941942; Tue, 21 Oct 2014 14:12:21 -0700 (PDT) Received: from localhost (c-853670d5.07-21-73746f28.cust.bredbandsbolaget.se. [213.112.54.133]) by mx.google.com with ESMTPSA id xu12sm4999963lab.12.2014.10.21.14.12.20 for (version=TLSv1.2 cipher=RC4-SHA bits=128/128); Tue, 21 Oct 2014 14:12:20 -0700 (PDT) From: Anders Roxell To: lng-odp@lists.linaro.org Date: Tue, 21 Oct 2014 23:12:11 +0200 Message-Id: <1413925932-8357-2-git-send-email-anders.roxell@linaro.org> X-Mailer: git-send-email 2.1.0 In-Reply-To: <1413925932-8357-1-git-send-email-anders.roxell@linaro.org> References: <1413925932-8357-1-git-send-email-anders.roxell@linaro.org> X-Topics: patch Subject: [lng-odp] [PATCHv2 1/2] doxygen: add grouping X-BeenThere: lng-odp@lists.linaro.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: , List-Help: , List-Subscribe: , MIME-Version: 1.0 Errors-To: lng-odp-bounces@lists.linaro.org Sender: lng-odp-bounces@lists.linaro.org X-Removed-Original-Auth: Dkim didn't pass. X-Original-Sender: anders.roxell@linaro.org X-Original-Authentication-Results: mx.google.com; spf=pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.215.51 as permitted sender) smtp.mail=patch+caf_=patchwork-forward=linaro.org@linaro.org Mailing-list: list patchwork-forward@linaro.org; contact patchwork-forward+owners@linaro.org X-Google-Group-Id: 836684582541 add submodules to gather the API docs. Signed-off-by: Anders Roxell --- platform/linux-generic/include/api/odp_align.h | 8 ++++++++ platform/linux-generic/include/api/odp_atomic.h | 8 ++++++++ platform/linux-generic/include/api/odp_barrier.h | 7 +++++++ platform/linux-generic/include/api/odp_buffer.h | 7 +++++++ platform/linux-generic/include/api/odp_buffer_pool.h | 8 ++++++++ platform/linux-generic/include/api/odp_byteorder.h | 8 ++++++++ platform/linux-generic/include/api/odp_classification.h | 9 +++++++++ platform/linux-generic/include/api/odp_compiler.h | 9 +++++++++ platform/linux-generic/include/api/odp_config.h | 8 ++++++++ platform/linux-generic/include/api/odp_coremask.h | 9 +++++++++ platform/linux-generic/include/api/odp_crypto.h | 9 +++++++++ platform/linux-generic/include/api/odp_debug.h | 9 +++++++++ platform/linux-generic/include/api/odp_hints.h | 7 +++++++ platform/linux-generic/include/api/odp_init.h | 7 +++++++ platform/linux-generic/include/api/odp_packet.h | 7 +++++++ platform/linux-generic/include/api/odp_packet_flags.h | 9 +++++++++ platform/linux-generic/include/api/odp_packet_io.h | 9 +++++++++ platform/linux-generic/include/api/odp_queue.h | 7 +++++++ platform/linux-generic/include/api/odp_rwlock.h | 9 +++++++++ platform/linux-generic/include/api/odp_schedule.h | 7 +++++++ platform/linux-generic/include/api/odp_shared_memory.h | 8 ++++++++ platform/linux-generic/include/api/odp_spinlock.h | 7 +++++++ platform/linux-generic/include/api/odp_sync.h | 7 +++++++ platform/linux-generic/include/api/odp_system_info.h | 6 ++++++ platform/linux-generic/include/api/odp_thread.h | 6 ++++++ platform/linux-generic/include/api/odp_ticketlock.h | 6 ++++++ platform/linux-generic/include/api/odp_time.h | 8 ++++++++ platform/linux-generic/include/api/odp_timer.h | 7 +++++++ platform/linux-generic/include/api/odp_version.h | 6 ++++++ 29 files changed, 222 insertions(+) diff --git a/platform/linux-generic/include/api/odp_align.h b/platform/linux-generic/include/api/odp_align.h index a93dd24..5c18b16 100644 --- a/platform/linux-generic/include/api/odp_align.h +++ b/platform/linux-generic/include/api/odp_align.h @@ -18,6 +18,11 @@ extern "C" { #endif +/** @addtogroup odp_compiler_optim + * Macros that allow cache line size configuration, check that + * alignment is a power of two etc. + * @{ + */ #ifdef __GNUC__ @@ -174,6 +179,9 @@ extern "C" { #define ODP_VAL_IS_POWER_2(x) ((((x)-1) & (x)) == 0) +/** + * @} + */ #ifdef __cplusplus } diff --git a/platform/linux-generic/include/api/odp_atomic.h b/platform/linux-generic/include/api/odp_atomic.h index 0cc4cf4..213c81f 100644 --- a/platform/linux-generic/include/api/odp_atomic.h +++ b/platform/linux-generic/include/api/odp_atomic.h @@ -21,6 +21,10 @@ extern "C" { #include +/** @addtogroup odp_synchronizers + * Atomic operations. + * @{ + */ /** * Atomic integer @@ -463,6 +467,10 @@ odp_atomic_cmpset_u64(odp_atomic_u64_t *dst, uint64_t exp, uint64_t src) return __sync_bool_compare_and_swap(dst, exp, src); } +/** + * @} + */ + #ifdef __cplusplus } #endif diff --git a/platform/linux-generic/include/api/odp_barrier.h b/platform/linux-generic/include/api/odp_barrier.h index a7b3215..866648f 100644 --- a/platform/linux-generic/include/api/odp_barrier.h +++ b/platform/linux-generic/include/api/odp_barrier.h @@ -22,6 +22,10 @@ extern "C" { #include #include +/** @addtogroup odp_synchronizers + * Barrier between threads. + * @{ + */ /** * ODP execution barrier @@ -48,6 +52,9 @@ void odp_barrier_init_count(odp_barrier_t *barrier, int count); */ void odp_barrier_sync(odp_barrier_t *barrier); +/** + * @} + */ #ifdef __cplusplus } diff --git a/platform/linux-generic/include/api/odp_buffer.h b/platform/linux-generic/include/api/odp_buffer.h index d8577fd..289e0eb 100644 --- a/platform/linux-generic/include/api/odp_buffer.h +++ b/platform/linux-generic/include/api/odp_buffer.h @@ -22,6 +22,10 @@ extern "C" { #include +/** @defgroup odp_buffer ODP BUFFER + * Operations on a buffer. + * @{ + */ /** * ODP buffer @@ -83,6 +87,9 @@ int odp_buffer_is_valid(odp_buffer_t buf); */ void odp_buffer_print(odp_buffer_t buf); +/** + * @} + */ #ifdef __cplusplus } diff --git a/platform/linux-generic/include/api/odp_buffer_pool.h b/platform/linux-generic/include/api/odp_buffer_pool.h index fe88898..d04abf0 100644 --- a/platform/linux-generic/include/api/odp_buffer_pool.h +++ b/platform/linux-generic/include/api/odp_buffer_pool.h @@ -23,6 +23,11 @@ extern "C" { #include #include +/** @addtogroup odp_buffer + * Operations on a buffer pool. + * @{ + */ + /** Maximum queue name lenght in chars */ #define ODP_BUFFER_POOL_NAME_LEN 32 @@ -99,6 +104,9 @@ void odp_buffer_free(odp_buffer_t buf); */ odp_buffer_pool_t odp_buffer_pool(odp_buffer_t buf); +/** + * @} + */ #ifdef __cplusplus } diff --git a/platform/linux-generic/include/api/odp_byteorder.h b/platform/linux-generic/include/api/odp_byteorder.h index e0f7a17..79ddd75 100644 --- a/platform/linux-generic/include/api/odp_byteorder.h +++ b/platform/linux-generic/include/api/odp_byteorder.h @@ -22,6 +22,11 @@ extern "C" { #include #include +/** @defgroup odp_compiler_optim ODP COMPILER / OPTIMIZATION + * Macros that check byte order and byte converting operations. + * @{ + */ + #ifndef __BYTE_ORDER #error __BYTE_ORDER not defined! #endif @@ -260,6 +265,9 @@ static inline uint64le_t odp_cpu_to_le_64(uint64_t cpu64) #endif } +/** + * @} + */ #ifdef __cplusplus } diff --git a/platform/linux-generic/include/api/odp_classification.h b/platform/linux-generic/include/api/odp_classification.h index 99b94e9..dcf5c9c 100644 --- a/platform/linux-generic/include/api/odp_classification.h +++ b/platform/linux-generic/include/api/odp_classification.h @@ -25,6 +25,11 @@ extern "C" { #include #include +/** @defgroup odp_classification ODP CLASSIFICATION + * Classification operations. + * @{ + */ + /** * Class of service instance type */ @@ -533,6 +538,10 @@ int odp_pmr_match_set_destroy(odp_pmr_set_t pmr_set_id); int odp_pktio_pmr_match_set_cos(odp_pmr_set_t pmr_set_id, odp_pktio_t src_pktio, odp_cos_t dst_cos); +/** + * @} + */ + #ifdef __cplusplus } #endif diff --git a/platform/linux-generic/include/api/odp_compiler.h b/platform/linux-generic/include/api/odp_compiler.h index a4e6e78..71a4431 100644 --- a/platform/linux-generic/include/api/odp_compiler.h +++ b/platform/linux-generic/include/api/odp_compiler.h @@ -18,6 +18,11 @@ extern "C" { #endif +/** @addtogroup odp_compiler_optim + * Macro for old compilers + * @{ + */ + /** @internal GNU compiler version */ #define GCC_VERSION (__GNUC__ * 10000 \ + __GNUC_MINOR__ * 100 \ @@ -35,6 +40,10 @@ extern "C" { #define __odp_builtin_bswap16(u16) __builtin_bswap16(u16) #endif +/** + * @} + */ + #ifdef __cplusplus } #endif diff --git a/platform/linux-generic/include/api/odp_config.h b/platform/linux-generic/include/api/odp_config.h index 7a15ff9..906897c 100644 --- a/platform/linux-generic/include/api/odp_config.h +++ b/platform/linux-generic/include/api/odp_config.h @@ -18,6 +18,10 @@ extern "C" { #endif +/** @addtogroup odp_compiler_optim + * Macro for maximum number of resources in ODP. + * @{ + */ /** * Maximum number of threads @@ -44,6 +48,10 @@ extern "C" { */ #define ODP_CONFIG_PKTIO_ENTRIES 64 +/** + * @} + */ + #ifdef __cplusplus } #endif diff --git a/platform/linux-generic/include/api/odp_coremask.h b/platform/linux-generic/include/api/odp_coremask.h index 141cb6a..d4172fa 100644 --- a/platform/linux-generic/include/api/odp_coremask.h +++ b/platform/linux-generic/include/api/odp_coremask.h @@ -22,6 +22,11 @@ extern "C" { #include +/** @addtogroup odp_scheduler + * Core mask operations. + * @{ + */ + /** @internal */ #define ODP_COREMASK_SIZE_U64 1 @@ -170,6 +175,10 @@ static inline int odp_coremask_equal(odp_coremask_t *mask1, return (mask1->_u64[0] == mask2->_u64[0]); } +/** + * @} + */ + #ifdef __cplusplus } #endif diff --git a/platform/linux-generic/include/api/odp_crypto.h b/platform/linux-generic/include/api/odp_crypto.h index 9220fb5..4741bcb 100644 --- a/platform/linux-generic/include/api/odp_crypto.h +++ b/platform/linux-generic/include/api/odp_crypto.h @@ -24,6 +24,11 @@ extern "C" { #include #include +/** @defgroup odp_crypto ODP CRYPTO + * Macros, enums, types and operations to utilise crypto. + * @{ + */ + /** Invalid session handle */ #define ODP_CRYPTO_SESSION_INVALID (0xffffffffffffffffULL) @@ -349,6 +354,10 @@ odp_crypto_get_operation_compl_ctx(odp_buffer_t completion_event); int odp_hw_random_get(uint8_t *buf, size_t *len, bool use_entropy); +/** + * @} + */ + #ifdef __cplusplus } #endif diff --git a/platform/linux-generic/include/api/odp_debug.h b/platform/linux-generic/include/api/odp_debug.h index e850bf3..0a20430 100644 --- a/platform/linux-generic/include/api/odp_debug.h +++ b/platform/linux-generic/include/api/odp_debug.h @@ -19,6 +19,11 @@ extern "C" { #endif +/** @addtogroup odp_ver_abt_log_dbg + * Macros that allows different messages. + * @{ + */ + #ifdef __GNUC__ /** @@ -125,6 +130,10 @@ do { \ #define ODP_ABORT(fmt, ...) \ ODP_LOG(ODP_LOG_ABORT, fmt, ##__VA_ARGS__) +/** + * @} + */ + #ifdef __cplusplus } #endif diff --git a/platform/linux-generic/include/api/odp_hints.h b/platform/linux-generic/include/api/odp_hints.h index e1cd1d0..bc6d720 100644 --- a/platform/linux-generic/include/api/odp_hints.h +++ b/platform/linux-generic/include/api/odp_hints.h @@ -18,6 +18,10 @@ extern "C" { #endif +/** @addtogroup odp_compiler_optim + * Macros that will give hints to the compiler. + * @{ + */ #ifdef __GNUC__ @@ -74,6 +78,9 @@ extern "C" { #endif +/** + * @} + */ #ifdef __cplusplus } diff --git a/platform/linux-generic/include/api/odp_init.h b/platform/linux-generic/include/api/odp_init.h index 002b6a3..8e018cb 100644 --- a/platform/linux-generic/include/api/odp_init.h +++ b/platform/linux-generic/include/api/odp_init.h @@ -31,6 +31,10 @@ extern "C" { #include +/** @defgroup odp_initialization ODP INITIALIZATION + * Initialisation operations. + * @{ + */ /** ODP initialization data. * Data that is required to initialize the ODP API with the @@ -128,6 +132,9 @@ int odp_init_local(void); */ int odp_term_local(void); +/** + * @} + */ #ifdef __cplusplus } diff --git a/platform/linux-generic/include/api/odp_packet.h b/platform/linux-generic/include/api/odp_packet.h index 316279b..890c9a9 100644 --- a/platform/linux-generic/include/api/odp_packet.h +++ b/platform/linux-generic/include/api/odp_packet.h @@ -20,6 +20,10 @@ extern "C" { #include +/** @defgroup odp_packet ODP PACKET + * Operations on a packet. + * @{ + */ /** * ODP packet descriptor @@ -442,6 +446,9 @@ int odp_packet_seg_push_tail(odp_packet_t pkt, odp_packet_seg_t seg, int odp_packet_seg_pull_tail(odp_packet_t pkt, odp_packet_seg_t seg, size_t len); +/** + * @} + */ #ifdef __cplusplus } diff --git a/platform/linux-generic/include/api/odp_packet_flags.h b/platform/linux-generic/include/api/odp_packet_flags.h index 2c19440..ccaa04f 100644 --- a/platform/linux-generic/include/api/odp_packet_flags.h +++ b/platform/linux-generic/include/api/odp_packet_flags.h @@ -21,6 +21,11 @@ extern "C" { #include #include +/** @addtogroup odp_packet + * Boolean operations on a packet. + * @{ + */ + /** * Check for packet errors * @@ -318,6 +323,10 @@ void odp_packet_set_inflag_sctp(odp_packet_t pkt, int val); */ void odp_packet_set_inflag_icmp(odp_packet_t pkt, int val); +/** + * @} + */ + #ifdef __cplusplus } #endif diff --git a/platform/linux-generic/include/api/odp_packet_io.h b/platform/linux-generic/include/api/odp_packet_io.h index f153ae2..360636d 100644 --- a/platform/linux-generic/include/api/odp_packet_io.h +++ b/platform/linux-generic/include/api/odp_packet_io.h @@ -23,6 +23,11 @@ extern "C" { #include #include +/** @defgroup odp_packet_io ODP PACKET IO + * Operations on a packet. + * @{ + */ + /** ODP packet IO handle */ typedef uint32_t odp_pktio_t; @@ -130,6 +135,10 @@ void odp_pktio_set_input(odp_packet_t pkt, odp_pktio_t id); */ odp_pktio_t odp_pktio_get_input(odp_packet_t pkt); +/** + * @} + */ + #ifdef __cplusplus } #endif diff --git a/platform/linux-generic/include/api/odp_queue.h b/platform/linux-generic/include/api/odp_queue.h index 6e8efa9..b8ac4bb 100644 --- a/platform/linux-generic/include/api/odp_queue.h +++ b/platform/linux-generic/include/api/odp_queue.h @@ -22,6 +22,10 @@ extern "C" { #include #include +/** @defgroup odp_queue ODP QUEUE + * Macros and operation on a queue. + * @{ + */ /** * ODP queue @@ -217,6 +221,9 @@ odp_queue_type_t odp_queue_type(odp_queue_t queue); */ odp_schedule_sync_t odp_queue_sched_type(odp_queue_t queue); +/** + * @} + */ #ifdef __cplusplus } diff --git a/platform/linux-generic/include/api/odp_rwlock.h b/platform/linux-generic/include/api/odp_rwlock.h index 252ebb2..a880f92 100644 --- a/platform/linux-generic/include/api/odp_rwlock.h +++ b/platform/linux-generic/include/api/odp_rwlock.h @@ -17,6 +17,11 @@ extern "C" { #endif +/** @defgroup odp_synchronizers ODP SYNCROIZERS + * Operations to a read/write lock. + * @{ + */ + /** * The odp_rwlock_t type. * write lock count is -1, @@ -63,6 +68,10 @@ void odp_rwlock_write_lock(odp_rwlock_t *rwlock); */ void odp_rwlock_write_unlock(odp_rwlock_t *rwlock); +/** + * @} + */ + #ifdef __cplusplus } #endif diff --git a/platform/linux-generic/include/api/odp_schedule.h b/platform/linux-generic/include/api/odp_schedule.h index 8087021..91fec10 100644 --- a/platform/linux-generic/include/api/odp_schedule.h +++ b/platform/linux-generic/include/api/odp_schedule.h @@ -23,6 +23,10 @@ extern "C" { #include #include +/** @defgroup odp_scheduler ODP SCHEDULER + * Operations on the scheduler. + * @{ + */ #define ODP_SCHED_WAIT 0 /**< Wait infinitely */ #define ODP_SCHED_NO_WAIT 1 /**< Do not wait */ @@ -136,6 +140,9 @@ void odp_schedule_release_atomic(void); */ int odp_schedule_num_prio(void); +/** + * @} + */ #ifdef __cplusplus } diff --git a/platform/linux-generic/include/api/odp_shared_memory.h b/platform/linux-generic/include/api/odp_shared_memory.h index 7ad29c3..d8d40dd 100644 --- a/platform/linux-generic/include/api/odp_shared_memory.h +++ b/platform/linux-generic/include/api/odp_shared_memory.h @@ -21,6 +21,11 @@ extern "C" { #include +/** @defgroup odp_shared_memory ODP SHARED MEMORY + * Operations on shared memory. + * @{ + */ + /** Maximum shared memory block name length in chars */ #define ODP_SHM_NAME_LEN 32 @@ -102,6 +107,9 @@ int odp_shm_info(odp_shm_t shm, odp_shm_info_t *info); */ void odp_shm_print_all(void); +/** + * @} + */ #ifdef __cplusplus } diff --git a/platform/linux-generic/include/api/odp_spinlock.h b/platform/linux-generic/include/api/odp_spinlock.h index 52b7a71..462ff97 100644 --- a/platform/linux-generic/include/api/odp_spinlock.h +++ b/platform/linux-generic/include/api/odp_spinlock.h @@ -21,6 +21,10 @@ extern "C" { #include +/** @addtogroup odp_synchronizers + * Operations on spinlock. + * @{ + */ /** * ODP spinlock @@ -75,6 +79,9 @@ int odp_spinlock_is_locked(odp_spinlock_t *spinlock); +/** + * @} + */ #ifdef __cplusplus } diff --git a/platform/linux-generic/include/api/odp_sync.h b/platform/linux-generic/include/api/odp_sync.h index fbf9abd..d9daada 100644 --- a/platform/linux-generic/include/api/odp_sync.h +++ b/platform/linux-generic/include/api/odp_sync.h @@ -18,6 +18,9 @@ extern "C" { #endif +/** @addtogroup odp_synchronizers + * @{ + */ /** * Synchronise stores @@ -52,6 +55,10 @@ static inline void odp_sync_stores(void) } +/** + * @} + */ + #ifdef __cplusplus } #endif diff --git a/platform/linux-generic/include/api/odp_system_info.h b/platform/linux-generic/include/api/odp_system_info.h index 7a02df7..bcd08d7 100644 --- a/platform/linux-generic/include/api/odp_system_info.h +++ b/platform/linux-generic/include/api/odp_system_info.h @@ -21,6 +21,9 @@ extern "C" { #include +/** @addtogroup odp_ver_abt_log_dbg + * @{ + */ /** * CPU frequency in Hz @@ -64,6 +67,9 @@ int odp_sys_cache_line_size(void); */ int odp_sys_core_count(void); +/** + * @} + */ #ifdef __cplusplus } diff --git a/platform/linux-generic/include/api/odp_thread.h b/platform/linux-generic/include/api/odp_thread.h index 5567748..2b7177d 100644 --- a/platform/linux-generic/include/api/odp_thread.h +++ b/platform/linux-generic/include/api/odp_thread.h @@ -18,6 +18,9 @@ extern "C" { #endif +/** @defgroup odp_thread ODP THREAD + * @{ + */ /** * Get thread id @@ -34,6 +37,9 @@ int odp_thread_id(void); */ int odp_thread_core(void); +/** + * @} + */ #ifdef __cplusplus } diff --git a/platform/linux-generic/include/api/odp_ticketlock.h b/platform/linux-generic/include/api/odp_ticketlock.h index 6277a18..a3b3ab5 100644 --- a/platform/linux-generic/include/api/odp_ticketlock.h +++ b/platform/linux-generic/include/api/odp_ticketlock.h @@ -22,6 +22,9 @@ extern "C" { #include #include +/** @addtogroup odp_synchronizers + * @{ + */ /** * ODP ticketlock @@ -75,6 +78,9 @@ void odp_ticketlock_unlock(odp_ticketlock_t *ticketlock); */ int odp_ticketlock_is_locked(odp_ticketlock_t *ticketlock); +/** + * @} + */ #ifdef __cplusplus } diff --git a/platform/linux-generic/include/api/odp_time.h b/platform/linux-generic/include/api/odp_time.h index ecddb54..85cc1ae 100644 --- a/platform/linux-generic/include/api/odp_time.h +++ b/platform/linux-generic/include/api/odp_time.h @@ -21,6 +21,10 @@ extern "C" { #include +/** @defgroup odp_system ODP SYSTEM + * @{ + */ + /* Time in nanoseconds */ #define ODP_TIME_USEC 1000UL /**< Microsecond in nsec */ #define ODP_TIME_MSEC 1000000UL /**< Millisecond in nsec */ @@ -65,6 +69,10 @@ uint64_t odp_time_cycles_to_ns(uint64_t cycles); */ uint64_t odp_time_ns_to_cycles(uint64_t ns); +/** + * @} + */ + #ifdef __cplusplus } #endif diff --git a/platform/linux-generic/include/api/odp_timer.h b/platform/linux-generic/include/api/odp_timer.h index 01db839..6cca27c 100644 --- a/platform/linux-generic/include/api/odp_timer.h +++ b/platform/linux-generic/include/api/odp_timer.h @@ -23,6 +23,9 @@ extern "C" { #include #include +/** @defgroup odp_timer ODP TIMER + * @{ + */ /** * ODP timer handle @@ -157,6 +160,10 @@ odp_timeout_t odp_timeout_from_buffer(odp_buffer_t buf); */ uint64_t odp_timeout_tick(odp_timeout_t tmo); +/** + * @} + */ + #ifdef __cplusplus } #endif diff --git a/platform/linux-generic/include/api/odp_version.h b/platform/linux-generic/include/api/odp_version.h index c823e2d..3a75201 100644 --- a/platform/linux-generic/include/api/odp_version.h +++ b/platform/linux-generic/include/api/odp_version.h @@ -18,6 +18,9 @@ extern "C" { #endif +/** @defgroup odp_ver_abt_log_dbg ODP LOGGING / ABORT / VERSION / DEBUG + * @{ + */ /** * ODP API main version @@ -68,6 +71,9 @@ static inline const char *odp_version_api_str(void) +/** + * @} + */ #ifdef __cplusplus }