arch/powerpc/include/asm/vio.h

   1 /*
   2  * IBM PowerPC Virtual I/O Infrastructure Support.
   3  *
   4  * Copyright (c) 2003 IBM Corp.
   5  *  Dave Engebretsen engebret@us.ibm.com
   6  *  Santiago Leon santil@us.ibm.com
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License
  10  * as published by the Free Software Foundation; either version
  11  * 2 of the License, or (at your option) any later version.
  12  */
  13
  14 #ifndef _ASM_POWERPC_VIO_H
  15 #define _ASM_POWERPC_VIO_H
  16 #ifdef __KERNEL__
  17
  18 #include <linux/errno.h>
  19 #include <linux/device.h>
  20 #include <linux/dma-mapping.h>
  21 #include <linux/mod_devicetable.h>
  22
  23 #include <asm/hvcall.h>
  24 #include <asm/scatterlist.h>
  25
  26 /*
  27  * Architecture-specific constants for drivers to
  28  * extract attributes of the device using vio_get_attribute()
  29  */
  30 #define VETH_MAC_ADDR "local-mac-address"
  31 #define VETH_MCAST_FILTER_SIZE "ibm,mac-address-filters"
  32
  33 /* End architecture-specific constants */
  34
  35 #define h_vio_signal(ua, mode) \
  36   plpar_hcall_norets(H_VIO_SIGNAL, ua, mode)
  37
  38 #define VIO_IRQ_DISABLE         0UL
  39 #define VIO_IRQ_ENABLE          1UL
  40
  41 /*
  42  * VIO CMO minimum entitlement for all devices and spare entitlement
  43  */
  44 #define VIO_CMO_MIN_ENT 1562624
  45
  46 extern struct bus_type vio_bus_type;
  47
  48 struct iommu_table;
  49
  50 /*
  51  * Platform Facilities Option (PFO)-specific data
  52  */
  53
  54 /* Starting unit address for PFO devices on the VIO BUS */
  55 #define VIO_BASE_PFO_UA 0x50000000
  56
  57 /**
  58  * vio_pfo_op - PFO operation parameters
  59  *
  60  * @flags: h_call subfunctions and modifiers
  61  * @in: Input data block logical real address
  62  * @inlen: If non-negative, the length of the input data block.  If negative,
  63  *      the length of the input data descriptor list in bytes.
  64  * @out: Output data block logical real address
  65  * @outlen: If non-negative, the length of the input data block.  If negative,
  66  *      the length of the input data descriptor list in bytes.
  67  * @csbcpb: Logical real address of the 4k naturally-aligned storage block
  68  *      containing the CSB & optional FC field specific CPB
  69  * @timeout: # of milliseconds to retry h_call, 0 for no timeout.
  70  * @hcall_err: pointer to return the h_call return value, else NULL
  71  */
  72 struct vio_pfo_op {
  73         u64 flags;
  74         s64 in;
  75         s64 inlen;
  76         s64 out;
  77         s64 outlen;
  78         u64 csbcpb;
  79         void *done;
  80         unsigned long handle;
  81         unsigned int timeout;
  82         long hcall_err;
  83 };
  84
  85 /* End PFO specific data */
  86
  87 enum vio_dev_family {
  88         VDEVICE,        /* The OF node is a child of /vdevice */
  89         PFO,            /* The OF node is a child of /ibm,platform-facilities */
  90 };
  91
  92 /**
  93  * vio_dev - This structure is used to describe virtual I/O devices.
  94  *
  95  * @desired: set from return of driver's get_desired_dma() function
  96  * @entitled: bytes of IO data that has been reserved for this device.
  97  * @allocated: bytes of IO data currently in use by the device.
  98  * @allocs_failed: number of DMA failures due to insufficient entitlement.
  99  */
 100 struct vio_dev {
 101         const char *name;
 102         const char *type;
 103         uint32_t unit_address;
 104         uint32_t resource_id;
 105         unsigned int irq;
 106         struct {
 107                 size_t desired;
 108                 size_t entitled;
 109                 size_t allocated;
 110                 atomic_t allocs_failed;
 111         } cmo;
 112         enum vio_dev_family family;
 113         struct device dev;
 114 };
 115
 116 struct vio_driver {
 117         const char *name;
 118         const struct vio_device_id *id_table;
 119         int (*probe)(struct vio_dev *dev, const struct vio_device_id *id);
 120         int (*remove)(struct vio_dev *dev);
 121         /* A driver must have a get_desired_dma() function to
 122          * be loaded in a CMO environment if it uses DMA.
 123          */
 124         unsigned long (*get_desired_dma)(struct vio_dev *dev);
 125         const struct dev_pm_ops *pm;
 126         struct device_driver driver;
 127 };
 128
 129 extern int __vio_register_driver(struct vio_driver *drv, struct module *owner,
 130                                  const char *mod_name);
 131 /*
 132  * vio_register_driver must be a macro so that KBUILD_MODNAME can be expanded
 133  */
 134 #define vio_register_driver(driver)             \
 135         __vio_register_driver(driver, THIS_MODULE, KBUILD_MODNAME)
 136 extern void vio_unregister_driver(struct vio_driver *drv);
 137
 138 extern int vio_cmo_entitlement_update(size_t);
 139 extern void vio_cmo_set_dev_desired(struct vio_dev *viodev, size_t desired);
 140
 141 extern void vio_unregister_device(struct vio_dev *dev);
 142
 143 extern int vio_h_cop_sync(struct vio_dev *vdev, struct vio_pfo_op *op);
 144
 145 struct device_node;
 146
 147 extern struct vio_dev *vio_register_device_node(
 148                 struct device_node *node_vdev);
 149 extern const void *vio_get_attribute(struct vio_dev *vdev, char *which,
 150                 int *length);
 151 #ifdef CONFIG_PPC_PSERIES
 152 extern struct vio_dev *vio_find_node(struct device_node *vnode);
 153 extern int vio_enable_interrupts(struct vio_dev *dev);
 154 extern int vio_disable_interrupts(struct vio_dev *dev);
 155 #else
 156 static inline int vio_enable_interrupts(struct vio_dev *dev)
 157 {
 158         return 0;
 159 }
 160 #endif
 161
 162 static inline struct vio_driver *to_vio_driver(struct device_driver *drv)
 163 {
 164         return container_of(drv, struct vio_driver, driver);
 165 }
 166
 167 static inline struct vio_dev *to_vio_dev(struct device *dev)
 168 {
 169         return container_of(dev, struct vio_dev, dev);
 170 }
 171
 172 #endif /* __KERNEL__ */
 173 #endif /* _ASM_POWERPC_VIO_H */