rte_bus.h

Go to the documentation of this file.

/*-
 *   BSD LICENSE
 *
 *   Copyright 2016 NXP
 *
 *   Redistribution and use in source and binary forms, with or without
 *   modification, are permitted provided that the following conditions
 *   are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in
 *       the documentation and/or other materials provided with the
 *       distribution.
 *     * Neither the name of NXP nor the names of its
 *       contributors may be used to endorse or promote products derived
 *       from this software without specific prior written permission.
 *
 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _RTE_BUS_H_
#define _RTE_BUS_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <stdio.h>
#include <sys/queue.h>

#include <rte_log.h>
#include <rte_dev.h>

TAILQ_HEAD(rte_bus_list, rte_bus);


enum rte_iova_mode {
    RTE_IOVA_DC = 0,    /* Don't care mode */
    RTE_IOVA_PA = (1 << 0), /* DMA using physical address */
    RTE_IOVA_VA = (1 << 1)  /* DMA using virtual address */
};

typedef int (*rte_bus_scan_t)(void);

typedef int (*rte_bus_probe_t)(void);

typedef struct rte_device *
(*rte_bus_find_device_t)(const struct rte_device *start, rte_dev_cmp_t cmp,
             const void *data);

typedef int (*rte_bus_plug_t)(struct rte_device *dev);

typedef int (*rte_bus_unplug_t)(struct rte_device *dev);

typedef int (*rte_bus_parse_t)(const char *name, void *addr);

typedef int (*rte_dev_dma_map_t)(struct rte_device *dev, void *addr,
                  uint64_t iova, size_t len);

typedef int (*rte_dev_dma_unmap_t)(struct rte_device *dev, void *addr,
                   uint64_t iova, size_t len);

typedef int (*rte_bus_hot_unplug_handler_t)(struct rte_device *dev);

typedef int (*rte_bus_sigbus_handler_t)(const void *failure_addr);

enum rte_bus_scan_mode {
    RTE_BUS_SCAN_UNDEFINED,
    RTE_BUS_SCAN_WHITELIST,
    RTE_BUS_SCAN_BLACKLIST,
};

struct rte_bus_conf {
    enum rte_bus_scan_mode scan_mode; 
};


typedef enum rte_iova_mode (*rte_bus_get_iommu_class_t)(void);


struct rte_bus {
    TAILQ_ENTRY(rte_bus) next;   
    const char *name;            
    rte_bus_scan_t scan;         
    rte_bus_probe_t probe;       
    rte_bus_find_device_t find_device; 
    rte_bus_plug_t plug;         
    rte_bus_unplug_t unplug;     
    rte_bus_parse_t parse;       
    rte_dev_dma_map_t dma_map;   
    rte_dev_dma_unmap_t dma_unmap; 
    struct rte_bus_conf conf;    
    rte_bus_get_iommu_class_t get_iommu_class; 
    rte_dev_iterate_t dev_iterate; 
    rte_bus_hot_unplug_handler_t hot_unplug_handler;
    rte_bus_sigbus_handler_t sigbus_handler;
};

void rte_bus_register(struct rte_bus *bus);

void rte_bus_unregister(struct rte_bus *bus);

int rte_bus_scan(void);

int rte_bus_probe(void);

void rte_bus_dump(FILE *f);

typedef int (*rte_bus_cmp_t)(const struct rte_bus *bus, const void *data);

struct rte_bus *rte_bus_find(const struct rte_bus *start, rte_bus_cmp_t cmp,
                 const void *data);

struct rte_bus *rte_bus_find_by_device(const struct rte_device *dev);

struct rte_bus *rte_bus_find_by_name(const char *busname);


enum rte_iova_mode rte_bus_get_iommu_class(void);

#define RTE_REGISTER_BUS(nm, bus) \
RTE_INIT_PRIO(businitfn_ ##nm, BUS) \
{\
    (bus).name = RTE_STR(nm);\
    rte_bus_register(&bus); \
}

#ifdef __cplusplus
}
#endif

#endif /* _RTE_BUS_H */