> -----Original Message-----
> From: lng-odp [mailto:lng-odp-boun...@lists.linaro.org] On Behalf Of Bill
> Fischofer
> Sent: Thursday, October 13, 2016 3:45 AM
> To: lng-odp@lists.linaro.org
> Subject: [lng-odp] [API-NEXT PATCHv2 1/2] api: dev: add device apis for
> numa support
> 
> Add the odp_dev_id() API used for NUMA support
> 
> Signed-off-by: Bill Fischofer <bill.fischo...@linaro.org>
> ---
>  include/odp/api/spec/dev.h | 89
> ++++++++++++++++++++++++++++++++++++++++++++++
>  1 file changed, 89 insertions(+)
>  create mode 100644 include/odp/api/spec/dev.h
> 
> diff --git a/include/odp/api/spec/dev.h b/include/odp/api/spec/dev.h
> new file mode 100644
> index 0000000..1f7ed8b
> --- /dev/null
> +++ b/include/odp/api/spec/dev.h
> @@ -0,0 +1,89 @@
> +/* Copyright (c) 2016, Linaro Limited
> + * All rights reserved.
> + *
> + * SPDX-License-Identifier:     BSD-3-Clause
> + */
> +
> +/**
> + * @file
> + *
> + * ODP device
> + */
> +
> +#ifndef ODP_API_DEV_H_
> +#define ODP_API_DEV_H_
> +#include <odp/visibility_begin.h>
> +
> +#ifdef __cplusplus
> +extern "C" {
> +#endif
> +
> +#include <odp/api/std_types.h>
> +
> +/** @defgroup odp_dev ODP DEVICE
> + *  Operations on devices
> + *  @{
> + */
> +
> +/**
> + * @typedef odp_dev_t
> + * ODP Device
> + */
> +
> +/**
> + * @def ODP_DEV_NAME_LEN
> + * Maximum device name length in chars

... (including null char). We'll harmonize all name length defines with that.


> + */
> +
> +/**
> + * @def ODP_DEV_ANY
> + * Any device
> + */

Change to ODP_DEV_DEFAULT, since it's more descriptive. Also _DEFAULT is 
already used by API and _ANY is not.

Also move specification text from below:

"The reserved id ODP_DEV_DEFAULT may be used as a default value ("don't care") 
wherever a device id is required."



> +
> +/**
> + * @def ODP_DEV_INVALID
> + * Invalid device
> + */
> +
> +/**
> + * Get Device ID by Name

No CamelCase please. "Get device identifier by name"


> + *
> + * Get an implementation-defined device identifier from a device name.
> Device
> + * names are supplied as parameter info (command line, file, etc.) to the
> + * application. This routine translates this symbolic name into an
> internal
> + * identifier that can be used to define a device connection hierarchy

... can be used to define a device for NUMA or other purposes.

No need to mention "connection hierarchy".


> for
> + * NUMA or other purposes.
> + *
> + * The reserved id ODP_DEV_ANY may be used as a "don't care" placeholder
> + * wherever a device id is required.

This should be moved from here to ODP_DEV_DEFAULT documentation. The default 
value is not needed for using the function, but where the dev ID is used.


> + *
> + * @param name Name of the device
> + *
> + * @return Device ID
> + * @retval ODP_DEV_INVALID Device is unknown
> + */
> +odp_dev_t odp_dev_id(const char *name);
> +
> +/**
> + * Get printable value for an odp_dev_t
> + *
> + * @param hdl  odp_dev_t handle to be printed


Better to use "dev" as param name than "hdl". That will be the common param 
name ("odp_dev_t dev") for other APIs.

-Petri


> + * @return     uint64_t value that can be used to print/display this
> + *             handle
> + *
> + * @note This routine is intended to be used for diagnostic purposes
> + * to enable applications to generate a printable value that represents
> + * an odp_dev_t handle.
> + */
> +uint64_t odp_dev_to_u64(odp_dev_t hdl);
> +
> +/**
> + * @}
> + */
> +
> +#ifdef __cplusplus
> +}
> +#endif
> +
> +#include <odp/visibility_end.h>
> +#endif
> --
> 2.7.4

Reply via email to