1afce3086c
Auxiliary bus [1] provides a way to split function into child-devices representing sub-domains of functionality. Each auxiliary device represents a part of its parent functionality. Auxiliary device is identified by unique device name, sysfs path: /sys/bus/auxiliary/devices/<name> Devargs legacy syntax of auxiliary device: -a auxiliary:<name>[,args...] Devargs generic syntax of auxiliary device: -a bus=auxiliary,name=<name>/class=<class>/driver=<driver>[,args...] [1] kernel auxiliary bus document: https://www.kernel.org/doc/html/latest/driver-api/auxiliary_bus.html Signed-off-by: Xueming Li <xuemingl@nvidia.com> Acked-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru> Acked-by: Thomas Monjalon <thomas@monjalon.net>
92 lines
2.6 KiB
C
92 lines
2.6 KiB
C
/* SPDX-License-Identifier: BSD-3-Clause
|
|
* Copyright (c) 2021 NVIDIA Corporation & Affiliates
|
|
*/
|
|
|
|
#ifndef BUS_AUXILIARY_PRIVATE_H
|
|
#define BUS_AUXILIARY_PRIVATE_H
|
|
|
|
#include <stdbool.h>
|
|
#include <stdio.h>
|
|
|
|
#include "rte_bus_auxiliary.h"
|
|
|
|
extern struct rte_auxiliary_bus auxiliary_bus;
|
|
extern int auxiliary_bus_logtype;
|
|
|
|
#define AUXILIARY_LOG(level, ...) \
|
|
rte_log(RTE_LOG_ ## level, auxiliary_bus_logtype, \
|
|
RTE_FMT("auxiliary bus: " RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
|
|
RTE_FMT_TAIL(__VA_ARGS__,)))
|
|
|
|
/* Auxiliary bus iterators */
|
|
#define FOREACH_DEVICE_ON_AUXILIARY_BUS(p) \
|
|
TAILQ_FOREACH(p, &(auxiliary_bus.device_list), next)
|
|
|
|
#define FOREACH_DRIVER_ON_AUXILIARY_BUS(p) \
|
|
TAILQ_FOREACH(p, &(auxiliary_bus.driver_list), next)
|
|
|
|
/* List of auxiliary devices. */
|
|
TAILQ_HEAD(rte_auxiliary_device_list, rte_auxiliary_device);
|
|
/* List of auxiliary drivers. */
|
|
TAILQ_HEAD(rte_auxiliary_driver_list, rte_auxiliary_driver);
|
|
|
|
/*
|
|
* Structure describing the auxiliary bus
|
|
*/
|
|
struct rte_auxiliary_bus {
|
|
struct rte_bus bus; /* Inherit the generic class */
|
|
struct rte_auxiliary_device_list device_list; /* List of devices */
|
|
struct rte_auxiliary_driver_list driver_list; /* List of drivers */
|
|
};
|
|
|
|
/*
|
|
* Test whether the auxiliary device exist.
|
|
*/
|
|
bool auxiliary_dev_exists(const char *name);
|
|
|
|
/*
|
|
* Scan the content of the auxiliary bus, and the devices in the devices
|
|
* list.
|
|
*/
|
|
int auxiliary_scan(void);
|
|
|
|
/*
|
|
* Update a device being scanned.
|
|
*/
|
|
void auxiliary_on_scan(struct rte_auxiliary_device *aux_dev);
|
|
|
|
/*
|
|
* Validate whether a device with given auxiliary device should be ignored
|
|
* or not.
|
|
*/
|
|
bool auxiliary_is_ignored_device(const char *name);
|
|
|
|
/*
|
|
* Add an auxiliary device to the auxiliary bus (append to auxiliary device
|
|
* list). This function also updates the bus references of the auxiliary
|
|
* device and the generic device object embedded within.
|
|
*/
|
|
void auxiliary_add_device(struct rte_auxiliary_device *aux_dev);
|
|
|
|
/*
|
|
* Insert an auxiliary device in the auxiliary bus at a particular location
|
|
* in the device list. It also updates the auxiliary bus reference of the
|
|
* new devices to be inserted.
|
|
*/
|
|
void auxiliary_insert_device(struct rte_auxiliary_device *exist_aux_dev,
|
|
struct rte_auxiliary_device *new_aux_dev);
|
|
|
|
/*
|
|
* Match the auxiliary driver and device by driver function.
|
|
*/
|
|
bool auxiliary_match(const struct rte_auxiliary_driver *aux_drv,
|
|
const struct rte_auxiliary_device *aux_dev);
|
|
|
|
/*
|
|
* Iterate over devices, matching any device against the provided string.
|
|
*/
|
|
void *auxiliary_dev_iterate(const void *start, const char *str,
|
|
const struct rte_dev_iterator *it);
|
|
|
|
#endif /* BUS_AUXILIARY_PRIVATE_H */
|