[API-NEXT,PATCHv3,1/5] drv: adding driver registration interface (stub)

Message ID 1481034217-16689-2-git-send-email-christophe.milard@linaro.org
State New
Headers show

Commit Message

Christophe Milard Dec. 6, 2016, 2:23 p.m.
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 | 311 ++++++++++++++++++++++++++++++++++++++++++
 platform/Makefile.inc         |   1 +
 2 files changed, 312 insertions(+)
 create mode 100644 include/odp/drv/spec/driver.h

-- 
2.7.4

Patch

diff --git a/include/odp/drv/spec/driver.h b/include/odp/drv/spec/driver.h
new file mode 100644
index 0000000..feb3523
--- /dev/null
+++ b/include/odp/drv/spec/driver.h
@@ -0,0 +1,311 @@ 
+/* Copyright (c) 2016, 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 load 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)  odpdrv_enum_class_register(int (probe*)()...)
+*      ----------------------------------------------------------->
+*      odrdrv_driver_register(int (probe*)()...)
+*      ----------------------------------------------------------->
+*      odpdrv devio register()
+*      ----------------------------------------------------------->
+*  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
+*      <-----------------------------------------------------------
+*      odrdrv_emum_register(int (probe*)()...)
+*      ----------------------------------------------------------->
+*      ----------------------------------------------------------->
+*      ----------------------------------------------------------->
+*      odrdrv_devio_register(...)
+*      ----------------------------------------------------------->
+*      ----------------------------------------------------------->
+*      ----------------------------------------------------------->
+*  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
+*  odrdrv_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.
+*  Note that the probe function of a given class may be recalled at any time
+*  (Hotplug)
+*  The devios delivered with their enumarator may also register at this stage.
+*
+*  4) For each enumerator instance , odp calls the probe function to retrieve
+*  the list of devices enumerated by the given enumerator instance.
+*  Note that the probe function of a given enumerator may be recalled at any
+*  time(Hotplug)
+*
+*  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 (E) api
+*	 (name and version)
+*	-device D was enumerated by enumerator 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 */
+typedef struct odpdrv_enum_class_t odpdrv_enum_class_t;
+typedef struct odpdrv_enum_t odpdrv_enum_t;
+typedef struct odpdrv_enumerated_dev_t odpdrv_enumerated_dev_t;
+typedef struct odpdrv_driver_t odpdrv_driver_t;
+
+/** maximum size for driver and enumerator names: */
+#define ODPDRV_NAME_MAX_SZ 32
+
+/** maximum size for the enumerator dependent address: */
+#define ODPDRV_NAME_ADDR_SZ 64
+
+/** The maximum number of interfaces an driver may support: */
+#define ODPDRV_MAX_DEVIOS 3
+
+/**
+* Parameter to be given at enumerator class registration:
+*/
+typedef struct odpdrv_enum_class_t {
+	/** enumerator name: mostly used for debug purpose.
+	 * Name must be unique (e.g. "PCI-DPAA2")
+	 */
+	const char name[ODPDRV_NAME_MAX_SZ];
+
+	/** enumerator api_name and version are used by the driver
+	 * to make sure the device being received at probe time is understood:
+	 * E.g. "PCI"
+	 * the format of the enum_dev part for the odpdrv_enumerated_dev_t
+	 * structure is identified by the api-name and version below
+	 */
+	const char enum_api_name[ODPDRV_NAME_MAX_SZ];
+	uint32_t enum_api_version;
+
+	/** 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);
+} odpdrv_enum_class_t;
+
+/**
+* Parameter to be given at enumerator (instance) registration:
+*/
+typedef struct odpdrv_enum_t {
+	/** class name
+	 * identifies the class of the enumerator
+	 */
+	const char class_name[ODPDRV_NAME_MAX_SZ];
+
+	/** Probe function:
+	 * called by ODP to get the enumerated device list
+	 */
+	odpdrv_enumerated_dev_t* (*probe)(void);
+
+	/** remove function:
+	 * free the list of enumerated devices.
+	 * This function is called in reverse order to device list creation
+	 */
+	int (*remove)(odpdrv_enumerated_dev_t *devlist);
+
+	/** register event notifier function for hotplug events:
+	 */
+	int (*register_notifier)(void (*event_handler) (void));
+} odpdrv_enum_t;
+
+/** 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.
+*/
+typedef struct odpdrv_enumerated_dev_t {
+	/** enumerator which enumerated the device:
+	 *
+	 */
+	 odpdrv_enum_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.
+	 * Filled at enumeration time.
+	 */
+	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;
+
+	/** next pointer for lists
+	 */
+	odpdrv_enumerated_dev_t *next;
+
+} odpdrv_enumerated_dev_t;
+
+/**
+ * Parameter to be given at devio registration:
+ */
+typedef struct odpdrv_devio_t {
+	/** devio name
+	 * identifies the device IO module in its enumerator domain
+	 * (i.e:many devios may have the same name, but none of them should
+	 * have a common enumerator class)
+	 */
+	const char name[ODPDRV_NAME_MAX_SZ];
+
+	/** version:
+	 * Identifies the devio API version (to be matched with driver
+	 * requests).
+	 */
+	uint32_t version;
+
+	/** enumerator class name
+	 * The enumerator this devio depends on.
+	 */
+	const char enumerator_class_name[ODPDRV_NAME_MAX_SZ];
+
+	/** ops
+	 * pointer to a devio ops structure (specific to each devio)
+	 */
+	void *ops;
+} odpdrv_devio_t;
+
+/**
+* Parameter to be given at driver registration:
+*/
+typedef struct odpdrv_driver_t {
+	/** driver name
+	 * the driver name (the pair {driver-name, enum-api-name} must
+	 * be unique)
+	 */
+	const char name[ODPDRV_NAME_MAX_SZ];
+
+	/** enumerator api name
+	 * the enumerator api name this driver works with
+	 */
+	const char enum_api_name[ODPDRV_NAME_MAX_SZ];
+
+	/** enumerator version
+	 * requested enumerator api version
+	 */
+	uint32_t enum_api_version;
+
+	/** 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 devio_name[ODPDRV_NAME_MAX_SZ];
+		uint32_t   devio_version;
+	} devios[ODPDRV_MAX_DEVIOS];
+
+	/** Probe function:
+	 * called by ODP to see if the driver can drive a given device
+	 *
+	 */
+	int (*probe)(odpdrv_enumerated_dev_t *dev);
+
+	/** remove function:
+	 * Only called with devices whose probe() returned true
+	 *
+	 */
+	int (*remove)(odpdrv_enumerated_dev_t *dev);
+
+} odpdrv_driver_t;
+
+/**
+* Register an enumerator class.
+* A call to this function should be made by all enumerator classes at init
+* time.
+* (called by an init function in the enumerator class, probably using gcc/clang
+* __constructor__ attribute.
+*
+* @param enum_class Pointer to a enumerator registration structure.
+* @return 0 on success, non-zero on error. On error, enumerators classes
+* should release allocated resources and return.
+*/
+int odrdrv_enum_class_register(odpdrv_enum_class_t *enum_class);
+
+/**
+* Register an enumerator.
+* A call to this function should be made by all enumerators at init time.
+* (called as a result of probing the enumerator class)
+*
+* @param enumerator Pointer to a enumerator registration structure.
+* @return 0 on success, non-zero on error. On error, enumerators
+* should release allocated resources and return.
+*/
+int odpdrv_enum_register(odpdrv_enum_t *enumerator);
+
+/**
+* Register an devio.
+* A call to this function should be made by all devios at init time.
+* (probably called as a result of probing the enumerator class, but could
+* also be separated modules)
+*
+* @param devio Pointer to a devio registration structure.
+* @return 0 on success, non-zero on error.
+*/
+int odpdrv_devio_register(odpdrv_devio_t *devio);
+
+/**
+* Register a Driver.
+* A call to this function should be made by all drivers at init time.
+* (called by an init function in the driver, probably using gcc/clang
+* __constructor__ attribute.
+*
+* @param odpdrv_driver_t Pointer to a driver registration structure.
+* @return 0 on success, non-zero on error. On error, drivers
+* should release allocated resources and return.
+*/
+int odpdrv_driver_register(odpdrv_driver_t *driver);
+
+/**
+* @}
+*/
+
+#ifdef __cplusplus
+}
+#endif
+
+#include <odp/visibility_end.h>
+#endif
diff --git a/platform/Makefile.inc b/platform/Makefile.inc
index b31b95b..69ee878 100644
--- a/platform/Makefile.inc
+++ b/platform/Makefile.inc
@@ -67,6 +67,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 \