Skip to content

Commit

Permalink
api: spec: correct coding style issues
Browse files Browse the repository at this point in the history
Clean checkpatch warnings that do not affect API signatures
in all api/spec header files.

Signed-off-by: Petri Savolainen <petri.savolainen@nokia.com>
Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org>
  • Loading branch information
psavol authored and MatiasElo committed Feb 4, 2019
1 parent 3be1cd5 commit 20d4c58
Show file tree
Hide file tree
Showing 25 changed files with 26 additions and 51 deletions.
1 change: 0 additions & 1 deletion include/odp/api/spec/align.h
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
* SPDX-License-Identifier: BSD-3-Clause
*/


/**
* @file
*
Expand Down
1 change: 0 additions & 1 deletion include/odp/api/spec/buffer.h
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
* SPDX-License-Identifier: BSD-3-Clause
*/


/**
* @file
*
Expand Down
19 changes: 9 additions & 10 deletions include/odp/api/spec/comp.h
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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
*
Expand Down Expand Up @@ -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
Expand Down
2 changes: 0 additions & 2 deletions include/odp/api/spec/cpu.h
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
* SPDX-License-Identifier: BSD-3-Clause
*/


/**
* @file
*
Expand All @@ -25,7 +24,6 @@ extern "C" {
* @{
*/


/**
* CPU identifier
*
Expand Down
1 change: 0 additions & 1 deletion include/odp/api/spec/cpumask.h
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
* SPDX-License-Identifier: BSD-3-Clause
*/


/**
* @file
*
Expand Down
1 change: 0 additions & 1 deletion include/odp/api/spec/crypto.h
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
* SPDX-License-Identifier: BSD-3-Clause
*/


/**
* @file
*
Expand Down
1 change: 0 additions & 1 deletion include/odp/api/spec/event.h
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
* SPDX-License-Identifier: BSD-3-Clause
*/


/**
* @file
*
Expand Down
7 changes: 1 addition & 6 deletions include/odp/api/spec/hints.h
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
* SPDX-License-Identifier: BSD-3-Clause
*/


/**
* @file
*
Expand Down Expand Up @@ -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)
*/

/**
Expand All @@ -84,8 +82,6 @@ extern "C" {
*/
#define odp_prefetch_store(x) __builtin_prefetch((x), 1, 3)



#else

#define ODP_WEAK_SYMBOL
Expand All @@ -99,7 +95,6 @@ extern "C" {

#endif


/**
* @}
*/
Expand Down
6 changes: 2 additions & 4 deletions include/odp/api/spec/init.h
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
* SPDX-License-Identifier: BSD-3-Clause
*/


/**
* @file
*
Expand Down Expand Up @@ -232,7 +231,6 @@ void odp_init_param_init(odp_init_t *param);
* passing any required platform specific data.
*/


/**
* Global ODP initialization
*
Expand Down Expand Up @@ -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()
Expand Down Expand Up @@ -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()
Expand Down
1 change: 0 additions & 1 deletion include/odp/api/spec/packet.h
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
* SPDX-License-Identifier: BSD-3-Clause
*/


/**
* @file
*
Expand Down
1 change: 0 additions & 1 deletion include/odp/api/spec/packet_flags.h
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
* SPDX-License-Identifier: BSD-3-Clause
*/


/**
* @file
*
Expand Down
17 changes: 12 additions & 5 deletions include/odp/api/spec/packet_io.h
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
* SPDX-License-Identifier: BSD-3-Clause
*/


/**
* @file
*
Expand Down Expand Up @@ -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;

/**
Expand Down
4 changes: 2 additions & 2 deletions include/odp/api/spec/packet_io_stats.h
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand Down
1 change: 0 additions & 1 deletion include/odp/api/spec/pool.h
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
* SPDX-License-Identifier: BSD-3-Clause
*/


/**
* @file
*
Expand Down
1 change: 0 additions & 1 deletion include/odp/api/spec/queue.h
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
* SPDX-License-Identifier: BSD-3-Clause
*/


/**
* @file
*
Expand Down
1 change: 0 additions & 1 deletion include/odp/api/spec/random.h
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
* SPDX-License-Identifier: BSD-3-Clause
*/


/**
* @file
*
Expand Down
1 change: 0 additions & 1 deletion include/odp/api/spec/rwlock.h
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@ extern "C" {
* ODP reader/writer lock
*/


/**
* Initialize a reader/writer lock.
*
Expand Down
1 change: 0 additions & 1 deletion include/odp/api/spec/schedule.h
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
* SPDX-License-Identifier: BSD-3-Clause
*/


/**
* @file
*
Expand Down
1 change: 0 additions & 1 deletion include/odp/api/spec/shared_memory.h
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
* SPDX-License-Identifier: BSD-3-Clause
*/


/**
* @file
*
Expand Down
1 change: 0 additions & 1 deletion include/odp/api/spec/std_types.h
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
* SPDX-License-Identifier: BSD-3-Clause
*/


/**
* @file
*
Expand Down
1 change: 0 additions & 1 deletion include/odp/api/spec/system_info.h
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
* SPDX-License-Identifier: BSD-3-Clause
*/


/**
* @file
*
Expand Down
2 changes: 0 additions & 2 deletions include/odp/api/spec/thread.h
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
* SPDX-License-Identifier: BSD-3-Clause
*/


/**
* @file
*
Expand Down Expand Up @@ -73,7 +72,6 @@ int odp_thread_count_max(void);
*/
odp_thread_type_t odp_thread_type(void);


/**
* @}
*/
Expand Down
3 changes: 0 additions & 3 deletions include/odp/api/spec/ticketlock.h
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
* SPDX-License-Identifier: BSD-3-Clause
*/


/**
* @file
*
Expand Down Expand Up @@ -44,7 +43,6 @@ extern "C" {
*/
void odp_ticketlock_init(odp_ticketlock_t *tklock);


/**
* Acquire ticket lock.
*
Expand All @@ -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.
*
Expand Down
1 change: 0 additions & 1 deletion include/odp/api/spec/time.h
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
* SPDX-License-Identifier: BSD-3-Clause
*/


/**
* @file
*
Expand Down
1 change: 0 additions & 1 deletion include/odp/api/spec/timer.h
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
* SPDX-License-Identifier: BSD-3-Clause
*/


/**
* @file
*
Expand Down

0 comments on commit 20d4c58

Please sign in to comment.