| Message ID | 1485280086-3958-2-git-send-email-christophe.milard@linaro.org |
|---|---|
| State | New |
| Headers | show |
| Series | driver initialisation framework | expand |
Hi, Christophe and team Sorry for not running distcheck while reviewing, I compared the v11 and v10 and looks good to me, ran make check, doxygen-run and distcheck passed, for this series: Reviewed-and-tested-by: Yi He <yi.he@linaro.org> Best Regards, Yi On 25 January 2017 at 01:48, Christophe Milard <christophe.milard@linaro.org > wrote: > The enumerator class, enumerator instance, devio and driver registration > functions prototypes (and a draft of their parameters) are > defined, the goal being to define the registration framework only. > > Signed-off-by: Christophe Milard <christophe.milard@linaro.org> > --- > include/odp/drv/spec/driver.h | 389 ++++++++++++++++++++++++++++++ > ++++++++++++ > platform/Makefile.inc | 1 + > 2 files changed, 390 insertions(+) > create mode 100644 include/odp/drv/spec/driver.h > > diff --git a/include/odp/drv/spec/driver.h b/include/odp/drv/spec/driver.h > new file mode 100644 > index 0000000..d83e907 > --- /dev/null > +++ b/include/odp/drv/spec/driver.h > @@ -0,0 +1,389 @@ > +/* Copyright (c) 2017, Linaro Limited > + * All rights reserved. > + * > + * SPDX-License-Identifier: BSD-3-Clause > + */ > + > +/** > + * @file > + * > + * ODPDRV driver > + */ > + > +#ifndef ODPDRV_DRIVER_H_ > +#define ODPDRV_DRIVER_H_ > +#include <odp/visibility_begin.h> > + > +#ifdef __cplusplus > +extern "C" { > +#endif > + > +/** > +* @addtogroup odpdrv_driver > +* @details > +* enumerator and driver interface to ODP > +* > +* 1) ODP loads the different modules (i.e. it loads shared libraries, > *.so). > +* In the context of drivers, shared libraries may contain enumerators, > +* drivers and devios. These register in step 2. > +* > +* 2) > +* @code > +* odpdrv_enumr_class_register(int (probe*)()...) > +* -----------------------------------------------------------> > +* odpdrv_driver_register(int (probe*)()...) > +* -----------------------------------------------------------> > +* odpdrv_devio_register() > +* -----------------------------------------------------------> > +* @endcode > +* A number of device_enumerator_classes are registered at the ODP > startup. > +* Many classes are expected: static, ACPI, PCI, switchdev, virtual, > DPAA2... > +* A number of drivers also register to ODP (passing their own probe > function). > +* A number of device IO may also register to ODP (defining available > devices > +* interfaces). > +* > +* 3) ODP calls the probe function of each enumerator class <BR> > +* @code > +* enumerator class probe() > +* <----------------------------------------------------------- > +* odpdrv_emum_register(int (probe*)()...) > +* -----------------------------------------------------------> > +* -----------------------------------------------------------> > +* -----------------------------------------------------------> > +* odpdrv_devio_register(...) > +* -----------------------------------------------------------> > +* -----------------------------------------------------------> > +* -----------------------------------------------------------> > +* @endcode > +* ODP calls the probe function of each registered enumerator_class. > +* This result in the enumerator_class registering some > +* enumerators (instances of the class) by calling > +* odpdrv_emumerator_register() for each instance. > +* A given enumerator_class may create many enumerators based on its > platform: > +* For instance Linux defines a number of PCI domains that can be viewed > as > +* multiple PCI enumerators. In addition, it could be considered that > each PCI > +* root of each processor socket in a NUMA environment has its own PCI > +* enumerator. > +* For enumerator class PCI, there could be one instance for each PCI > +* domain. > +* The devios delivered with their enumerator may also register at this > stage. > +* > +* 4) > +* @code > +* enumerator probe() > +* <----------------------------------------------------------- > +* odpdrv_device_create() > +* -----------------------------------------------------------> > +* odpdrv_device_create() > +* -----------------------------------------------------------> > +* odpdrv_device_create() > +* -----------------------------------------------------------> > +* @endcode > +* For each enumerator instance, odp calls the probe function. > +* This will trigger devices creation (Enumerators calls odpdrv > +* odpdrv_device_create() for each new device). Enumerators are allowed > +* to call odpdrv_device_create() at any time once they have been probed > +* (hotplug). They also may call odpdrv_device_destroy() if needed. > +* > +* 5) The driver framework calls the drivers probe(D,I) functions of the > +* drivers, with device D and devio I as parameter, assuming that: > +* -devio I was on the driver supported list of devio (and version > matches) > +* -the devio I is registered and found its enumerator interface(E) > api > +* (name and version) > +* -device D was enumerated by an enumerator providing interface E. > +* The return value of the driver probe function tells whether the driver > +* can handle the device or not. > +* > +* @{ > +*/ > + > +/* Forward declarations for a top down description of structures */ > +/** Parameters for enumerator class registration */ > +typedef struct odpdrv_enumr_class_param_t odpdrv_enumr_class_param_t; > +/** Parameters for enumerator registration */ > +typedef struct odpdrv_enumr_param_t odpdrv_enumr_param_t; > +/** Parameters for new device creation */ > +typedef struct odpdrv_device_param_t odpdrv_device_param_t; > +/** Parameters for devio registration*/ > +typedef struct odpdrv_devio_param_t odpdrv_devio_param_t; > +/** Parameters for driver registration*/ > +typedef struct odpdrv_driver_param_t odpdrv_driver_param_t; > + > +/** > + * @typedef odpdrv_enumr_class_t > + * ODPDRV enumerator class, such as PCI. > + */ > +/** > + * @def ODPDRV_ENUMR_CLASS_INVALID > + * Invalid odpdrv enumerator class > + */ > + > +/** > + * @typedef odpdrv_enumr_t > + * ODPDRV enumerator. Instance of odpdrv_enumr_class_t. > + */ > +/** > + * @def ODPDRV_ENUMR_INVALID > + * Invalid odpdrv enumerator > + */ > + > +/** > + * @typedef odpdrv_device_t > + * ODPDRV device. Created and destroyed by enumerators > + */ > +/** > + * @def ODPDRV_DEVICE_INVALID > + * Invalid odpdrv device > + */ > + > +/** > + * @typedef odpdrv_devio_t > + * ODPDRV device IO interface. > + */ > +/** > + * @def ODPDRV_DEVIO_INVALID > + * Invalid odpdrv device IO > + */ > + > +/** > + * @typedef odpdrv_driver_t > + * ODPDRV device driver. > + */ > +/** > + * @def ODPDRV_DRIVER_INVALID > + * Invalid odpdrv driver > + */ > + > +/** Maximum size for driver and enumerator names */ > +#define ODPDRV_NAME_SIZE 32 > + > +/** Maximum size for the enumerator dependent address */ > +#define ODPDRV_NAME_ADDR_SZ 64 > + > +/** The maximum number of interfaces a driver may support */ > +#define ODPDRV_MAX_DEVIOS 3 > + > +/** > +* Parameters to be given at enumerator class registration > +*/ > +struct odpdrv_enumr_class_param_t { > + /** Enumerator name: mostly used for debug purpose. > + * Name must be unique (e.g. "PCI-DPAA2") > + */ > + const char name[ODPDRV_NAME_SIZE]; > + > + /** Probe function: > + * Called by ODP to get the enumerator class instances registered > + */ > + int (*probe)(void); > + > + /** Remove function: > + * Free whatever resource the class may have allocated. > + */ > + int (*remove)(void); > +}; > + > +/** > +* Parameter to be given at enumerator (instance) registration > +*/ > +struct odpdrv_enumr_param_t { > + /** Class > + * Identifies the class of the enumerator > + */ > + odpdrv_enumr_class_t enumr_class; > + > + /** Enumerator api_name and version are used by the devio > + * to make sure the device can be accessed: > + * E.g. "PCI" > + * The format of the enum_dev part for the odpdrv_device_param_t > + * structure is identified by the api-name and version below > + */ > + const char api_name[ODPDRV_NAME_SIZE]; > + uint32_t api_version; /**<< the version of the provided API */ > + > + /** Probe function: > + * Called by ODP when it is ready for device creation/deletion > + * returns an negative value on error or 0 on success. > + */ > + int (*probe)(void); > + > + /** Remove function: > + * destroy all enumerated devices and release all resources > + */ > + int (*remove)(void); > + > + /** Register event notifier function for hotplug events: > + * register_notifier(fcnt,event_mask) registers fcnt as a > callback when > + * one of the event specified in event_mask occurs. > + */ > + int (*register_notifier)(void (*event_handler) (uint64_t event), > + int64_t event_mask); > +}; > + > +/* The following events are supported by enumerators */ > +#define ODPDRV_ENUM_EV_REMOVED 0x0000000000000001 /**<< remove event */ > + > +/** This structure defines a generic enumerated device, or actually the > +* common part between all devices, the enumerator specific part being > pointed > +* by the enum_dev field below. > +*/ > +struct odpdrv_device_param_t { > + /** enumerator > + * enumerator which enumerated the device: as returned by > + * odpdrv_enumr_register > + * devices with parents get destroyed when the parents dies. > + */ > + odpdrv_enumr_t enumerator; > + > + /** Device address: > + * An enumerator dependent string giving the device address, > + * e.g. "0000.23.12.1" for PCI domain 0, bus 23, device 12, > function 1. > + * This string identifies the device uniquely. > + */ > + const char address[ODPDRV_NAME_ADDR_SZ]; > + > + /** Enumerator dependent part > + * This part is allocated by the enumerator and is enumerator > dependent > + * (i.e. different devices types will have different contents for > + * enum_dev). > + */ > + void *enum_dev; > +}; > + > +/** > + * Parameter to be given at devio registration > + */ > +struct odpdrv_devio_param_t { > + /** Devio name > + * Identifies devio interface implemented by this devio > + * (i.e:many devios may have the same name, but none of those > + * with same provided interface should refer to a common enumerator > + * class) > + */ > + const char api_name[ODPDRV_NAME_SIZE]; > + uint32_t api_version; /**<< the version of the provided API */ > + > + /** Enumerator interface name and version > + * The enumerator interface this devio needs. > + */ > + const char enumr_api_name[ODPDRV_NAME_SIZE]; > + uint32_t enumr_api_version; /**<< required enumerator API version > */ > + > + /** Ops > + * Pointer to a devio ops structure (specific to each devio) > + */ > + void *ops; > +}; > + > +/** > +* Parameter to be given at driver registration > +*/ > +struct odpdrv_driver_param_t { > + /** Driver name > + * The driver name (the pair {driver-name, enum-api-name} must > + * be unique) > + */ > + const char name[ODPDRV_NAME_SIZE]; > + > + /** Supported devios: > + * The list of supported devio: one of the following devio > + * (with correct version) must be available for the driver to work: > + */ > + struct { > + const char api_name[ODPDRV_NAME_SIZE]; /**<< devio API > name */ > + uint32_t api_version; /**<< devio API version */ > + } devios[ODPDRV_MAX_DEVIOS]; > + > + /** Probe function: > + * Called by ODP to see if the driver can drive a given device > + * > + */ > + int (*probe)(odpdrv_device_t *dev); > + > + /** Remove function: > + * Only called with devices whose probe() returned true > + * > + */ > + int (*remove)(odpdrv_device_param_t *dev); > + > +}; > + > +/** > +* Register an enumerator class. > +* Each enumerator class calls this function at init time. > +* (probably using gcc/clang * __constructor__ attribute.) > +* > +* @param param Pointer to a enumerator class registration structure. > +* @return an enumerator class handle or ODPDRV_ENUMR_CLASS_INVALID on > error. > +* On errors, enumerators classes should release allocated resources and > return. > +*/ > +odpdrv_enumr_class_t odpdrv_enumr_class_register( > odpdrv_enumr_class_param_t > + *param); > + > +/** > +* Register an enumerator. > +* Each enumerator calls this function at init time. > +* (probably using gcc/clang * __constructor__ attribute.) > +* > +* @param param Pointer to a enumerator registration parameter structure. > +* @return an enumerator handle or ODPDRV_ENUMR_INVALID on error. > +* On errors, enumerators should release allocated resources and return. > +*/ > +odpdrv_enumr_t odpdrv_enumr_register(odpdrv_enumr_param_t *param); > + > +/** > +* Create a device > +* Called by each enumerator at probe time, or anytime later, for each > +* new created device > +* @param param Pointer to a device parameter structure. > +* @return an odpdrv devuice handle or ODPDRV_DEVICE_INVALID on error. > +*/ > +odpdrv_device_t odpdrv_device_create(odpdrv_device_param_t *param); > + > +/** > +* Destroy a device > +* Called by each enumerator at probe time, or anytime later, for each > +* destroyed created device > +* @param dev A odpdrv device handle as returned by odpdrv_device_create. > +* @return 0 on success or a negative value on error. > +*/ > +void odpdrv_device_destroy(odpdrv_device_t dev); > + > +/** > +* Register an devio. > +* Each devio calls this function at init time. > +* (probably using gcc/clang * __constructor__ attribute.) > +* > +* @param param Pointer to a devio registration structure. > +* @return an odpdrv_devio_t handle or ODPDRV_DEVIO_INVALID on error. > +*/ > +odpdrv_devio_t odpdrv_devio_register(odpdrv_devio_param_t *param); > + > +/** > +* Register a Driver. > +* Each driver calls this function at init time. > +* (probably using gcc/clang * __constructor__ attribute.) > +* > +* @param param Pointer to a driver registration structure. > +* @return an odpdrv_driver_t handle or ODPDRV_DRIVER_INVALID on error. > +* On errors, drivers should release allocated resources and return. > +*/ > +odpdrv_driver_t odpdrv_driver_register(odpdrv_driver_param_t *param); > + > +/** > +* Print (ODP_DBG) the driver interface status (debug). > +* > +* @return 0 on success, less than zero on error (inconsistency detected) > +*/ > +int odpdrv_print_all(void); > + > +/** > +* @} > +*/ > + > +#ifdef __cplusplus > +} > +#endif > + > +#include <odp/visibility_end.h> > +#endif > diff --git a/platform/Makefile.inc b/platform/Makefile.inc > index aefbf9a..57026d0 100644 > --- a/platform/Makefile.inc > +++ b/platform/Makefile.inc > @@ -68,6 +68,7 @@ odpdrvspecinclude_HEADERS = \ > $(top_srcdir)/include/odp/drv/spec/barrier.h \ > $(top_srcdir)/include/odp/drv/spec/byteorder.h \ > $(top_srcdir)/include/odp/drv/spec/compiler.h \ > + $(top_srcdir)/include/odp/drv/spec/driver.h \ > $(top_srcdir)/include/odp/drv/spec/shm.h \ > $(top_srcdir)/include/odp/drv/spec/spinlock.h \ > $(top_srcdir)/include/odp/drv/spec/std_types.h \ > -- > 2.7.4 > >
Merged, Maxim. On 01/25/17 05:28, Yi He wrote: > Hi, Christophe and team > > Sorry for not running distcheck while reviewing, I compared the v11 and > v10 and looks good to me, ran make check, doxygen-run and distcheck > passed, for this series: > > Reviewed-and-tested-by: Yi He <yi.he@linaro.org <mailto:yi.he@linaro.org>> > > Best Regards, Yi > > > > > > On 25 January 2017 at 01:48, Christophe Milard > <christophe.milard@linaro.org <mailto:christophe.milard@linaro.org>> wrote: > > The enumerator class, enumerator instance, devio and driver registration > functions prototypes (and a draft of their parameters) are > defined, the goal being to define the registration framework only. > > Signed-off-by: Christophe Milard <christophe.milard@linaro.org > <mailto:christophe.milard@linaro.org>> > --- > include/odp/drv/spec/driver.h | 389 > ++++++++++++++++++++++++++++++++++++++++++ > platform/Makefile.inc | 1 + > 2 files changed, 390 insertions(+) > create mode 100644 include/odp/drv/spec/driver.h > > diff --git a/include/odp/drv/spec/driver.h > b/include/odp/drv/spec/driver.h > new file mode 100644 > index 0000000..d83e907 > --- /dev/null > +++ b/include/odp/drv/spec/driver.h > @@ -0,0 +1,389 @@ > +/* Copyright (c) 2017, Linaro Limited > + * All rights reserved. > + * > + * SPDX-License-Identifier: BSD-3-Clause > + */ > + > +/** > + * @file > + * > + * ODPDRV driver > + */ > + > +#ifndef ODPDRV_DRIVER_H_ > +#define ODPDRV_DRIVER_H_ > +#include <odp/visibility_begin.h> > + > +#ifdef __cplusplus > +extern "C" { > +#endif > + > +/** > +* @addtogroup odpdrv_driver > +* @details > +* enumerator and driver interface to ODP > +* > +* 1) ODP loads the different modules (i.e. it loads shared > libraries, *.so). > +* In the context of drivers, shared libraries may contain > enumerators, > +* drivers and devios. These register in step 2. > +* > +* 2) > +* @code > +* odpdrv_enumr_class_register(int (probe*)()...) > +* -----------------------------------------------------------> > +* odpdrv_driver_register(int (probe*)()...) > +* -----------------------------------------------------------> > +* odpdrv_devio_register() > +* -----------------------------------------------------------> > +* @endcode > +* A number of device_enumerator_classes are registered at the ODP > startup. > +* Many classes are expected: static, ACPI, PCI, switchdev, > virtual, DPAA2... > +* A number of drivers also register to ODP (passing their own > probe function). > +* A number of device IO may also register to ODP (defining > available devices > +* interfaces). > +* > +* 3) ODP calls the probe function of each enumerator class <BR> > +* @code > +* enumerator class probe() > +* <----------------------------------------------------------- > +* odpdrv_emum_register(int (probe*)()...) > +* -----------------------------------------------------------> > +* -----------------------------------------------------------> > +* -----------------------------------------------------------> > +* odpdrv_devio_register(...) > +* -----------------------------------------------------------> > +* -----------------------------------------------------------> > +* -----------------------------------------------------------> > +* @endcode > +* ODP calls the probe function of each registered enumerator_class. > +* This result in the enumerator_class registering some > +* enumerators (instances of the class) by calling > +* odpdrv_emumerator_register() for each instance. > +* A given enumerator_class may create many enumerators based on > its platform: > +* For instance Linux defines a number of PCI domains that can be > viewed as > +* multiple PCI enumerators. In addition, it could be considered > that each PCI > +* root of each processor socket in a NUMA environment has its own PCI > +* enumerator. > +* For enumerator class PCI, there could be one instance for each PCI > +* domain. > +* The devios delivered with their enumerator may also register at > this stage. > +* > +* 4) > +* @code > +* enumerator probe() > +* <----------------------------------------------------------- > +* odpdrv_device_create() > +* -----------------------------------------------------------> > +* odpdrv_device_create() > +* -----------------------------------------------------------> > +* odpdrv_device_create() > +* -----------------------------------------------------------> > +* @endcode > +* For each enumerator instance, odp calls the probe function. > +* This will trigger devices creation (Enumerators calls odpdrv > +* odpdrv_device_create() for each new device). Enumerators are allowed > +* to call odpdrv_device_create() at any time once they have been > probed > +* (hotplug). They also may call odpdrv_device_destroy() if needed. > +* > +* 5) The driver framework calls the drivers probe(D,I) functions > of the > +* drivers, with device D and devio I as parameter, assuming that: > +* -devio I was on the driver supported list of devio (and > version matches) > +* -the devio I is registered and found its enumerator > interface(E) api > +* (name and version) > +* -device D was enumerated by an enumerator providing interface E. > +* The return value of the driver probe function tells whether the > driver > +* can handle the device or not. > +* > +* @{ > +*/ > + > +/* Forward declarations for a top down description of structures */ > +/** Parameters for enumerator class registration */ > +typedef struct odpdrv_enumr_class_param_t odpdrv_enumr_class_param_t; > +/** Parameters for enumerator registration */ > +typedef struct odpdrv_enumr_param_t odpdrv_enumr_param_t; > +/** Parameters for new device creation */ > +typedef struct odpdrv_device_param_t odpdrv_device_param_t; > +/** Parameters for devio registration*/ > +typedef struct odpdrv_devio_param_t odpdrv_devio_param_t; > +/** Parameters for driver registration*/ > +typedef struct odpdrv_driver_param_t odpdrv_driver_param_t; > + > +/** > + * @typedef odpdrv_enumr_class_t > + * ODPDRV enumerator class, such as PCI. > + */ > +/** > + * @def ODPDRV_ENUMR_CLASS_INVALID > + * Invalid odpdrv enumerator class > + */ > + > +/** > + * @typedef odpdrv_enumr_t > + * ODPDRV enumerator. Instance of odpdrv_enumr_class_t. > + */ > +/** > + * @def ODPDRV_ENUMR_INVALID > + * Invalid odpdrv enumerator > + */ > + > +/** > + * @typedef odpdrv_device_t > + * ODPDRV device. Created and destroyed by enumerators > + */ > +/** > + * @def ODPDRV_DEVICE_INVALID > + * Invalid odpdrv device > + */ > + > +/** > + * @typedef odpdrv_devio_t > + * ODPDRV device IO interface. > + */ > +/** > + * @def ODPDRV_DEVIO_INVALID > + * Invalid odpdrv device IO > + */ > + > +/** > + * @typedef odpdrv_driver_t > + * ODPDRV device driver. > + */ > +/** > + * @def ODPDRV_DRIVER_INVALID > + * Invalid odpdrv driver > + */ > + > +/** Maximum size for driver and enumerator names */ > +#define ODPDRV_NAME_SIZE 32 > + > +/** Maximum size for the enumerator dependent address */ > +#define ODPDRV_NAME_ADDR_SZ 64 > + > +/** The maximum number of interfaces a driver may support */ > +#define ODPDRV_MAX_DEVIOS 3 > + > +/** > +* Parameters to be given at enumerator class registration > +*/ > +struct odpdrv_enumr_class_param_t { > + /** Enumerator name: mostly used for debug purpose. > + * Name must be unique (e.g. "PCI-DPAA2") > + */ > + const char name[ODPDRV_NAME_SIZE]; > + > + /** Probe function: > + * Called by ODP to get the enumerator class instances > registered > + */ > + int (*probe)(void); > + > + /** Remove function: > + * Free whatever resource the class may have allocated. > + */ > + int (*remove)(void); > +}; > + > +/** > +* Parameter to be given at enumerator (instance) registration > +*/ > +struct odpdrv_enumr_param_t { > + /** Class > + * Identifies the class of the enumerator > + */ > + odpdrv_enumr_class_t enumr_class; > + > + /** Enumerator api_name and version are used by the devio > + * to make sure the device can be accessed: > + * E.g. "PCI" > + * The format of the enum_dev part for the odpdrv_device_param_t > + * structure is identified by the api-name and version below > + */ > + const char api_name[ODPDRV_NAME_SIZE]; > + uint32_t api_version; /**<< the version of the provided API */ > + > + /** Probe function: > + * Called by ODP when it is ready for device creation/deletion > + * returns an negative value on error or 0 on success. > + */ > + int (*probe)(void); > + > + /** Remove function: > + * destroy all enumerated devices and release all resources > + */ > + int (*remove)(void); > + > + /** Register event notifier function for hotplug events: > + * register_notifier(fcnt,event_mask) registers fcnt as a > callback when > + * one of the event specified in event_mask occurs. > + */ > + int (*register_notifier)(void (*event_handler) (uint64_t event), > + int64_t event_mask); > +}; > + > +/* The following events are supported by enumerators */ > +#define ODPDRV_ENUM_EV_REMOVED 0x0000000000000001 /**<< remove event */ > + > +/** This structure defines a generic enumerated device, or actually the > +* common part between all devices, the enumerator specific part > being pointed > +* by the enum_dev field below. > +*/ > +struct odpdrv_device_param_t { > + /** enumerator > + * enumerator which enumerated the device: as returned by > + * odpdrv_enumr_register > + * devices with parents get destroyed when the parents dies. > + */ > + odpdrv_enumr_t enumerator; > + > + /** Device address: > + * An enumerator dependent string giving the device address, > + * e.g. "0000.23.12.1" for PCI domain 0, bus 23, device 12, > function 1. > + * This string identifies the device uniquely. > + */ > + const char address[ODPDRV_NAME_ADDR_SZ]; > + > + /** Enumerator dependent part > + * This part is allocated by the enumerator and is > enumerator dependent > + * (i.e. different devices types will have different > contents for > + * enum_dev). > + */ > + void *enum_dev; > +}; > + > +/** > + * Parameter to be given at devio registration > + */ > +struct odpdrv_devio_param_t { > + /** Devio name > + * Identifies devio interface implemented by this devio > + * (i.e:many devios may have the same name, but none of those > + * with same provided interface should refer to a common > enumerator > + * class) > + */ > + const char api_name[ODPDRV_NAME_SIZE]; > + uint32_t api_version; /**<< the version of the provided API */ > + > + /** Enumerator interface name and version > + * The enumerator interface this devio needs. > + */ > + const char enumr_api_name[ODPDRV_NAME_SIZE]; > + uint32_t enumr_api_version; /**<< required enumerator API > version */ > + > + /** Ops > + * Pointer to a devio ops structure (specific to each devio) > + */ > + void *ops; > +}; > + > +/** > +* Parameter to be given at driver registration > +*/ > +struct odpdrv_driver_param_t { > + /** Driver name > + * The driver name (the pair {driver-name, enum-api-name} must > + * be unique) > + */ > + const char name[ODPDRV_NAME_SIZE]; > + > + /** Supported devios: > + * The list of supported devio: one of the following devio > + * (with correct version) must be available for the driver > to work: > + */ > + struct { > + const char api_name[ODPDRV_NAME_SIZE]; /**<< devio > API name */ > + uint32_t api_version; /**<< devio API version */ > + } devios[ODPDRV_MAX_DEVIOS]; > + > + /** Probe function: > + * Called by ODP to see if the driver can drive a given device > + * > + */ > + int (*probe)(odpdrv_device_t *dev); > + > + /** Remove function: > + * Only called with devices whose probe() returned true > + * > + */ > + int (*remove)(odpdrv_device_param_t *dev); > + > +}; > + > +/** > +* Register an enumerator class. > +* Each enumerator class calls this function at init time. > +* (probably using gcc/clang * __constructor__ attribute.) > +* > +* @param param Pointer to a enumerator class registration structure. > +* @return an enumerator class handle or ODPDRV_ENUMR_CLASS_INVALID > on error. > +* On errors, enumerators classes should release allocated resources > and return. > +*/ > +odpdrv_enumr_class_t > odpdrv_enumr_class_register(odpdrv_enumr_class_param_t > + *param); > + > +/** > +* Register an enumerator. > +* Each enumerator calls this function at init time. > +* (probably using gcc/clang * __constructor__ attribute.) > +* > +* @param param Pointer to a enumerator registration parameter > structure. > +* @return an enumerator handle or ODPDRV_ENUMR_INVALID on error. > +* On errors, enumerators should release allocated resources and return. > +*/ > +odpdrv_enumr_t odpdrv_enumr_register(odpdrv_enumr_param_t *param); > + > +/** > +* Create a device > +* Called by each enumerator at probe time, or anytime later, for each > +* new created device > +* @param param Pointer to a device parameter structure. > +* @return an odpdrv devuice handle or ODPDRV_DEVICE_INVALID on error. > +*/ > +odpdrv_device_t odpdrv_device_create(odpdrv_device_param_t *param); > + > +/** > +* Destroy a device > +* Called by each enumerator at probe time, or anytime later, for each > +* destroyed created device > +* @param dev A odpdrv device handle as returned by > odpdrv_device_create. > +* @return 0 on success or a negative value on error. > +*/ > +void odpdrv_device_destroy(odpdrv_device_t dev); > + > +/** > +* Register an devio. > +* Each devio calls this function at init time. > +* (probably using gcc/clang * __constructor__ attribute.) > +* > +* @param param Pointer to a devio registration structure. > +* @return an odpdrv_devio_t handle or ODPDRV_DEVIO_INVALID on error. > +*/ > +odpdrv_devio_t odpdrv_devio_register(odpdrv_devio_param_t *param); > + > +/** > +* Register a Driver. > +* Each driver calls this function at init time. > +* (probably using gcc/clang * __constructor__ attribute.) > +* > +* @param param Pointer to a driver registration structure. > +* @return an odpdrv_driver_t handle or ODPDRV_DRIVER_INVALID on error. > +* On errors, drivers should release allocated resources and return. > +*/ > +odpdrv_driver_t odpdrv_driver_register(odpdrv_driver_param_t *param); > + > +/** > +* Print (ODP_DBG) the driver interface status (debug). > +* > +* @return 0 on success, less than zero on error (inconsistency > detected) > +*/ > +int odpdrv_print_all(void); > + > +/** > +* @} > +*/ > + > +#ifdef __cplusplus > +} > +#endif > + > +#include <odp/visibility_end.h> > +#endif > diff --git a/platform/Makefile.inc b/platform/Makefile.inc > index aefbf9a..57026d0 100644 > --- a/platform/Makefile.inc > +++ b/platform/Makefile.inc > @@ -68,6 +68,7 @@ odpdrvspecinclude_HEADERS = \ > $(top_srcdir)/include/odp/drv/spec/barrier.h \ > $(top_srcdir)/include/odp/drv/spec/byteorder.h \ > $(top_srcdir)/include/odp/drv/spec/compiler.h \ > + $(top_srcdir)/include/odp/drv/spec/driver.h \ > $(top_srcdir)/include/odp/drv/spec/shm.h \ > $(top_srcdir)/include/odp/drv/spec/spinlock.h \ > $(top_srcdir)/include/odp/drv/spec/std_types.h \ > -- > 2.7.4 > >
diff --git a/include/odp/drv/spec/driver.h b/include/odp/drv/spec/driver.h new file mode 100644 index 0000000..d83e907 --- /dev/null +++ b/include/odp/drv/spec/driver.h @@ -0,0 +1,389 @@ +/* Copyright (c) 2017, Linaro Limited + * All rights reserved. + * + * SPDX-License-Identifier: BSD-3-Clause + */ + +/** + * @file + * + * ODPDRV driver + */ + +#ifndef ODPDRV_DRIVER_H_ +#define ODPDRV_DRIVER_H_ +#include <odp/visibility_begin.h> + +#ifdef __cplusplus +extern "C" { +#endif + +/** +* @addtogroup odpdrv_driver +* @details +* enumerator and driver interface to ODP +* +* 1) ODP loads the different modules (i.e. it loads shared libraries, *.so). +* In the context of drivers, shared libraries may contain enumerators, +* drivers and devios. These register in step 2. +* +* 2) +* @code +* odpdrv_enumr_class_register(int (probe*)()...) +* -----------------------------------------------------------> +* odpdrv_driver_register(int (probe*)()...) +* -----------------------------------------------------------> +* odpdrv_devio_register() +* -----------------------------------------------------------> +* @endcode +* A number of device_enumerator_classes are registered at the ODP startup. +* Many classes are expected: static, ACPI, PCI, switchdev, virtual, DPAA2... +* A number of drivers also register to ODP (passing their own probe function). +* A number of device IO may also register to ODP (defining available devices +* interfaces). +* +* 3) ODP calls the probe function of each enumerator class <BR> +* @code +* enumerator class probe() +* <----------------------------------------------------------- +* odpdrv_emum_register(int (probe*)()...) +* -----------------------------------------------------------> +* -----------------------------------------------------------> +* -----------------------------------------------------------> +* odpdrv_devio_register(...) +* -----------------------------------------------------------> +* -----------------------------------------------------------> +* -----------------------------------------------------------> +* @endcode +* ODP calls the probe function of each registered enumerator_class. +* This result in the enumerator_class registering some +* enumerators (instances of the class) by calling +* odpdrv_emumerator_register() for each instance. +* A given enumerator_class may create many enumerators based on its platform: +* For instance Linux defines a number of PCI domains that can be viewed as +* multiple PCI enumerators. In addition, it could be considered that each PCI +* root of each processor socket in a NUMA environment has its own PCI +* enumerator. +* For enumerator class PCI, there could be one instance for each PCI +* domain. +* The devios delivered with their enumerator may also register at this stage. +* +* 4) +* @code +* enumerator probe() +* <----------------------------------------------------------- +* odpdrv_device_create() +* -----------------------------------------------------------> +* odpdrv_device_create() +* -----------------------------------------------------------> +* odpdrv_device_create() +* -----------------------------------------------------------> +* @endcode +* For each enumerator instance, odp calls the probe function. +* This will trigger devices creation (Enumerators calls odpdrv +* odpdrv_device_create() for each new device). Enumerators are allowed +* to call odpdrv_device_create() at any time once they have been probed +* (hotplug). They also may call odpdrv_device_destroy() if needed. +* +* 5) The driver framework calls the drivers probe(D,I) functions of the +* drivers, with device D and devio I as parameter, assuming that: +* -devio I was on the driver supported list of devio (and version matches) +* -the devio I is registered and found its enumerator interface(E) api +* (name and version) +* -device D was enumerated by an enumerator providing interface E. +* The return value of the driver probe function tells whether the driver +* can handle the device or not. +* +* @{ +*/ + +/* Forward declarations for a top down description of structures */ +/** Parameters for enumerator class registration */ +typedef struct odpdrv_enumr_class_param_t odpdrv_enumr_class_param_t; +/** Parameters for enumerator registration */ +typedef struct odpdrv_enumr_param_t odpdrv_enumr_param_t; +/** Parameters for new device creation */ +typedef struct odpdrv_device_param_t odpdrv_device_param_t; +/** Parameters for devio registration*/ +typedef struct odpdrv_devio_param_t odpdrv_devio_param_t; +/** Parameters for driver registration*/ +typedef struct odpdrv_driver_param_t odpdrv_driver_param_t; + +/** + * @typedef odpdrv_enumr_class_t + * ODPDRV enumerator class, such as PCI. + */ +/** + * @def ODPDRV_ENUMR_CLASS_INVALID + * Invalid odpdrv enumerator class + */ + +/** + * @typedef odpdrv_enumr_t + * ODPDRV enumerator. Instance of odpdrv_enumr_class_t. + */ +/** + * @def ODPDRV_ENUMR_INVALID + * Invalid odpdrv enumerator + */ + +/** + * @typedef odpdrv_device_t + * ODPDRV device. Created and destroyed by enumerators + */ +/** + * @def ODPDRV_DEVICE_INVALID + * Invalid odpdrv device + */ + +/** + * @typedef odpdrv_devio_t + * ODPDRV device IO interface. + */ +/** + * @def ODPDRV_DEVIO_INVALID + * Invalid odpdrv device IO + */ + +/** + * @typedef odpdrv_driver_t + * ODPDRV device driver. + */ +/** + * @def ODPDRV_DRIVER_INVALID + * Invalid odpdrv driver + */ + +/** Maximum size for driver and enumerator names */ +#define ODPDRV_NAME_SIZE 32 + +/** Maximum size for the enumerator dependent address */ +#define ODPDRV_NAME_ADDR_SZ 64 + +/** The maximum number of interfaces a driver may support */ +#define ODPDRV_MAX_DEVIOS 3 + +/** +* Parameters to be given at enumerator class registration +*/ +struct odpdrv_enumr_class_param_t { + /** Enumerator name: mostly used for debug purpose. + * Name must be unique (e.g. "PCI-DPAA2") + */ + const char name[ODPDRV_NAME_SIZE]; + + /** Probe function: + * Called by ODP to get the enumerator class instances registered + */ + int (*probe)(void); + + /** Remove function: + * Free whatever resource the class may have allocated. + */ + int (*remove)(void); +}; + +/** +* Parameter to be given at enumerator (instance) registration +*/ +struct odpdrv_enumr_param_t { + /** Class + * Identifies the class of the enumerator + */ + odpdrv_enumr_class_t enumr_class; + + /** Enumerator api_name and version are used by the devio + * to make sure the device can be accessed: + * E.g. "PCI" + * The format of the enum_dev part for the odpdrv_device_param_t + * structure is identified by the api-name and version below + */ + const char api_name[ODPDRV_NAME_SIZE]; + uint32_t api_version; /**<< the version of the provided API */ + + /** Probe function: + * Called by ODP when it is ready for device creation/deletion + * returns an negative value on error or 0 on success. + */ + int (*probe)(void); + + /** Remove function: + * destroy all enumerated devices and release all resources + */ + int (*remove)(void); + + /** Register event notifier function for hotplug events: + * register_notifier(fcnt,event_mask) registers fcnt as a callback when + * one of the event specified in event_mask occurs. + */ + int (*register_notifier)(void (*event_handler) (uint64_t event), + int64_t event_mask); +}; + +/* The following events are supported by enumerators */ +#define ODPDRV_ENUM_EV_REMOVED 0x0000000000000001 /**<< remove event */ + +/** This structure defines a generic enumerated device, or actually the +* common part between all devices, the enumerator specific part being pointed +* by the enum_dev field below. +*/ +struct odpdrv_device_param_t { + /** enumerator + * enumerator which enumerated the device: as returned by + * odpdrv_enumr_register + * devices with parents get destroyed when the parents dies. + */ + odpdrv_enumr_t enumerator; + + /** Device address: + * An enumerator dependent string giving the device address, + * e.g. "0000.23.12.1" for PCI domain 0, bus 23, device 12, function 1. + * This string identifies the device uniquely. + */ + const char address[ODPDRV_NAME_ADDR_SZ]; + + /** Enumerator dependent part + * This part is allocated by the enumerator and is enumerator dependent + * (i.e. different devices types will have different contents for + * enum_dev). + */ + void *enum_dev; +}; + +/** + * Parameter to be given at devio registration + */ +struct odpdrv_devio_param_t { + /** Devio name + * Identifies devio interface implemented by this devio + * (i.e:many devios may have the same name, but none of those + * with same provided interface should refer to a common enumerator + * class) + */ + const char api_name[ODPDRV_NAME_SIZE]; + uint32_t api_version; /**<< the version of the provided API */ + + /** Enumerator interface name and version + * The enumerator interface this devio needs. + */ + const char enumr_api_name[ODPDRV_NAME_SIZE]; + uint32_t enumr_api_version; /**<< required enumerator API version */ + + /** Ops + * Pointer to a devio ops structure (specific to each devio) + */ + void *ops; +}; + +/** +* Parameter to be given at driver registration +*/ +struct odpdrv_driver_param_t { + /** Driver name + * The driver name (the pair {driver-name, enum-api-name} must + * be unique) + */ + const char name[ODPDRV_NAME_SIZE]; + + /** Supported devios: + * The list of supported devio: one of the following devio + * (with correct version) must be available for the driver to work: + */ + struct { + const char api_name[ODPDRV_NAME_SIZE]; /**<< devio API name */ + uint32_t api_version; /**<< devio API version */ + } devios[ODPDRV_MAX_DEVIOS]; + + /** Probe function: + * Called by ODP to see if the driver can drive a given device + * + */ + int (*probe)(odpdrv_device_t *dev); + + /** Remove function: + * Only called with devices whose probe() returned true + * + */ + int (*remove)(odpdrv_device_param_t *dev); + +}; + +/** +* Register an enumerator class. +* Each enumerator class calls this function at init time. +* (probably using gcc/clang * __constructor__ attribute.) +* +* @param param Pointer to a enumerator class registration structure. +* @return an enumerator class handle or ODPDRV_ENUMR_CLASS_INVALID on error. +* On errors, enumerators classes should release allocated resources and return. +*/ +odpdrv_enumr_class_t odpdrv_enumr_class_register(odpdrv_enumr_class_param_t + *param); + +/** +* Register an enumerator. +* Each enumerator calls this function at init time. +* (probably using gcc/clang * __constructor__ attribute.) +* +* @param param Pointer to a enumerator registration parameter structure. +* @return an enumerator handle or ODPDRV_ENUMR_INVALID on error. +* On errors, enumerators should release allocated resources and return. +*/ +odpdrv_enumr_t odpdrv_enumr_register(odpdrv_enumr_param_t *param); + +/** +* Create a device +* Called by each enumerator at probe time, or anytime later, for each +* new created device +* @param param Pointer to a device parameter structure. +* @return an odpdrv devuice handle or ODPDRV_DEVICE_INVALID on error. +*/ +odpdrv_device_t odpdrv_device_create(odpdrv_device_param_t *param); + +/** +* Destroy a device +* Called by each enumerator at probe time, or anytime later, for each +* destroyed created device +* @param dev A odpdrv device handle as returned by odpdrv_device_create. +* @return 0 on success or a negative value on error. +*/ +void odpdrv_device_destroy(odpdrv_device_t dev); + +/** +* Register an devio. +* Each devio calls this function at init time. +* (probably using gcc/clang * __constructor__ attribute.) +* +* @param param Pointer to a devio registration structure. +* @return an odpdrv_devio_t handle or ODPDRV_DEVIO_INVALID on error. +*/ +odpdrv_devio_t odpdrv_devio_register(odpdrv_devio_param_t *param); + +/** +* Register a Driver. +* Each driver calls this function at init time. +* (probably using gcc/clang * __constructor__ attribute.) +* +* @param param Pointer to a driver registration structure. +* @return an odpdrv_driver_t handle or ODPDRV_DRIVER_INVALID on error. +* On errors, drivers should release allocated resources and return. +*/ +odpdrv_driver_t odpdrv_driver_register(odpdrv_driver_param_t *param); + +/** +* Print (ODP_DBG) the driver interface status (debug). +* +* @return 0 on success, less than zero on error (inconsistency detected) +*/ +int odpdrv_print_all(void); + +/** +* @} +*/ + +#ifdef __cplusplus +} +#endif + +#include <odp/visibility_end.h> +#endif diff --git a/platform/Makefile.inc b/platform/Makefile.inc index aefbf9a..57026d0 100644 --- a/platform/Makefile.inc +++ b/platform/Makefile.inc @@ -68,6 +68,7 @@ odpdrvspecinclude_HEADERS = \ $(top_srcdir)/include/odp/drv/spec/barrier.h \ $(top_srcdir)/include/odp/drv/spec/byteorder.h \ $(top_srcdir)/include/odp/drv/spec/compiler.h \ + $(top_srcdir)/include/odp/drv/spec/driver.h \ $(top_srcdir)/include/odp/drv/spec/shm.h \ $(top_srcdir)/include/odp/drv/spec/spinlock.h \ $(top_srcdir)/include/odp/drv/spec/std_types.h \
The enumerator class, enumerator instance, devio and driver registration functions prototypes (and a draft of their parameters) are defined, the goal being to define the registration framework only. Signed-off-by: Christophe Milard <christophe.milard@linaro.org> --- include/odp/drv/spec/driver.h | 389 ++++++++++++++++++++++++++++++++++++++++++ platform/Makefile.inc | 1 + 2 files changed, 390 insertions(+) create mode 100644 include/odp/drv/spec/driver.h -- 2.7.4