123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203 |
- /*
- * Freescale Management Complex (MC) bus public interface
- *
- * Copyright (C) 2014 Freescale Semiconductor, Inc.
- * Author: German Rivera <German.Rivera@freescale.com>
- *
- * This file is licensed under the terms of the GNU General Public
- * License version 2. This program is licensed "as is" without any
- * warranty of any kind, whether express or implied.
- */
- #ifndef _FSL_MC_H_
- #define _FSL_MC_H_
- #include <linux/device.h>
- #include <linux/mod_devicetable.h>
- #include <linux/list.h>
- #include "../include/dprc.h"
- #define FSL_MC_VENDOR_FREESCALE 0x1957
- struct fsl_mc_device;
- struct fsl_mc_io;
- /**
- * struct fsl_mc_driver - MC object device driver object
- * @driver: Generic device driver
- * @match_id_table: table of supported device matching Ids
- * @probe: Function called when a device is added
- * @remove: Function called when a device is removed
- * @shutdown: Function called at shutdown time to quiesce the device
- * @suspend: Function called when a device is stopped
- * @resume: Function called when a device is resumed
- *
- * Generic DPAA device driver object for device drivers that are registered
- * with a DPRC bus. This structure is to be embedded in each device-specific
- * driver structure.
- */
- struct fsl_mc_driver {
- struct device_driver driver;
- const struct fsl_mc_device_match_id *match_id_table;
- int (*probe)(struct fsl_mc_device *dev);
- int (*remove)(struct fsl_mc_device *dev);
- void (*shutdown)(struct fsl_mc_device *dev);
- int (*suspend)(struct fsl_mc_device *dev, pm_message_t state);
- int (*resume)(struct fsl_mc_device *dev);
- };
- #define to_fsl_mc_driver(_drv) \
- container_of(_drv, struct fsl_mc_driver, driver)
- /**
- * struct fsl_mc_device_match_id - MC object device Id entry for driver matching
- * @vendor: vendor ID
- * @obj_type: MC object type
- * @ver_major: MC object version major number
- * @ver_minor: MC object version minor number
- *
- * Type of entries in the "device Id" table for MC object devices supported by
- * a MC object device driver. The last entry of the table has vendor set to 0x0
- */
- struct fsl_mc_device_match_id {
- u16 vendor;
- const char obj_type[16];
- u32 ver_major;
- u32 ver_minor;
- };
- /**
- * enum fsl_mc_pool_type - Types of allocatable MC bus resources
- *
- * Entries in these enum are used as indices in the array of resource
- * pools of an fsl_mc_bus object.
- */
- enum fsl_mc_pool_type {
- FSL_MC_POOL_DPMCP = 0x0, /* corresponds to "dpmcp" in the MC */
- FSL_MC_POOL_DPBP, /* corresponds to "dpbp" in the MC */
- FSL_MC_POOL_DPCON, /* corresponds to "dpcon" in the MC */
- /*
- * NOTE: New resource pool types must be added before this entry
- */
- FSL_MC_NUM_POOL_TYPES
- };
- /**
- * struct fsl_mc_resource - MC generic resource
- * @type: type of resource
- * @id: unique MC resource Id within the resources of the same type
- * @data: pointer to resource-specific data if the resource is currently
- * allocated, or NULL if the resource is not currently allocated.
- * @parent_pool: pointer to the parent resource pool from which this
- * resource is allocated from.
- * @node: Node in the free list of the corresponding resource pool
- *
- * NOTE: This structure is to be embedded as a field of specific
- * MC resource structures.
- */
- struct fsl_mc_resource {
- enum fsl_mc_pool_type type;
- int32_t id;
- void *data;
- struct fsl_mc_resource_pool *parent_pool;
- struct list_head node;
- };
- /**
- * Bit masks for a MC object device (struct fsl_mc_device) flags
- */
- #define FSL_MC_IS_DPRC 0x0001
- /**
- * Default DMA mask for devices on a fsl-mc bus
- */
- #define FSL_MC_DEFAULT_DMA_MASK (~0ULL)
- /**
- * struct fsl_mc_device - MC object device object
- * @dev: Linux driver model device object
- * @dma_mask: Default DMA mask
- * @flags: MC object device flags
- * @icid: Isolation context ID for the device
- * @mc_handle: MC handle for the corresponding MC object opened
- * @mc_io: Pointer to MC IO object assigned to this device or
- * NULL if none.
- * @obj_desc: MC description of the DPAA device
- * @regions: pointer to array of MMIO region entries
- * @resource: generic resource associated with this MC object device, if any.
- *
- * Generic device object for MC object devices that are "attached" to a
- * MC bus.
- *
- * NOTES:
- * - For a non-DPRC object its icid is the same as its parent DPRC's icid.
- * - The SMMU notifier callback gets invoked after device_add() has been
- * called for an MC object device, but before the device-specific probe
- * callback gets called.
- * - DP_OBJ_DPRC objects are the only MC objects that have built-in MC
- * portals. For all other MC objects, their device drivers are responsible for
- * allocating MC portals for them by calling fsl_mc_portal_allocate().
- * - Some types of MC objects (e.g., DP_OBJ_DPBP, DP_OBJ_DPCON) are
- * treated as resources that can be allocated/deallocated from the
- * corresponding resource pool in the object's parent DPRC, using the
- * fsl_mc_object_allocate()/fsl_mc_object_free() functions. These MC objects
- * are known as "allocatable" objects. For them, the corresponding
- * fsl_mc_device's 'resource' points to the associated resource object.
- * For MC objects that are not allocatable (e.g., DP_OBJ_DPRC, DP_OBJ_DPNI),
- * 'resource' is NULL.
- */
- struct fsl_mc_device {
- struct device dev;
- u64 dma_mask;
- u16 flags;
- u16 icid;
- u16 mc_handle;
- struct fsl_mc_io *mc_io;
- struct dprc_obj_desc obj_desc;
- struct resource *regions;
- struct fsl_mc_resource *resource;
- };
- #define to_fsl_mc_device(_dev) \
- container_of(_dev, struct fsl_mc_device, dev)
- /*
- * module_fsl_mc_driver() - Helper macro for drivers that don't do
- * anything special in module init/exit. This eliminates a lot of
- * boilerplate. Each module may only use this macro once, and
- * calling it replaces module_init() and module_exit()
- */
- #define module_fsl_mc_driver(__fsl_mc_driver) \
- module_driver(__fsl_mc_driver, fsl_mc_driver_register, \
- fsl_mc_driver_unregister)
- /*
- * Macro to avoid include chaining to get THIS_MODULE
- */
- #define fsl_mc_driver_register(drv) \
- __fsl_mc_driver_register(drv, THIS_MODULE)
- int __must_check __fsl_mc_driver_register(struct fsl_mc_driver *fsl_mc_driver,
- struct module *owner);
- void fsl_mc_driver_unregister(struct fsl_mc_driver *driver);
- bool fsl_mc_bus_exists(void);
- int __must_check fsl_mc_portal_allocate(struct fsl_mc_device *mc_dev,
- u16 mc_io_flags,
- struct fsl_mc_io **new_mc_io);
- void fsl_mc_portal_free(struct fsl_mc_io *mc_io);
- int fsl_mc_portal_reset(struct fsl_mc_io *mc_io);
- int __must_check fsl_mc_object_allocate(struct fsl_mc_device *mc_dev,
- enum fsl_mc_pool_type pool_type,
- struct fsl_mc_device **new_mc_adev);
- void fsl_mc_object_free(struct fsl_mc_device *mc_adev);
- extern struct bus_type fsl_mc_bus_type;
- #endif /* _FSL_MC_H_ */
|