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