4 #include <linux/kernel.h>
5 #include <linux/device.h>
6 #include <linux/mod_devicetable.h>
7 #include <linux/timer.h>
8 #include <linux/spinlock.h>
9 #include <linux/completion.h>
10 #include <linux/list.h>
11 #include <linux/log2.h>
14 #include <asm/mdesc.h>
18 #define VIO_TYPE_CTRL 0x01
19 #define VIO_TYPE_DATA 0x02
20 #define VIO_TYPE_ERR 0x04
23 #define VIO_SUBTYPE_INFO 0x01
24 #define VIO_SUBTYPE_ACK 0x02
25 #define VIO_SUBTYPE_NACK 0x04
28 #define VIO_VER_INFO 0x0001
29 #define VIO_ATTR_INFO 0x0002
30 #define VIO_DRING_REG 0x0003
31 #define VIO_DRING_UNREG 0x0004
32 #define VIO_RDX 0x0005
33 #define VIO_PKT_DATA 0x0040
34 #define VIO_DESC_DATA 0x0041
35 #define VIO_DRING_DATA 0x0042
36 #define VNET_MCAST_INFO 0x0101
42 struct vio_msg_tag tag;
47 struct vio_msg_tag tag;
51 #define VDEV_NETWORK 0x01
52 #define VDEV_NETWORK_SWITCH 0x02
53 #define VDEV_DISK 0x03
54 #define VDEV_DISK_SERVER 0x04
60 struct vio_dring_register {
61 struct vio_msg_tag tag;
66 #define VIO_TX_DRING 0x0001
67 #define VIO_RX_DRING 0x0002
68 #define VIO_RX_DRING_DATA 0x0004
71 struct ldc_trans_cookie cookies[0];
74 struct vio_dring_unregister {
75 struct vio_msg_tag tag;
80 /* Data transfer modes */
81 #define VIO_PKT_MODE 0x01 /* Packet based transfer */
82 #define VIO_DESC_MODE 0x02 /* In-band descriptors */
83 #define VIO_DRING_MODE 0x03 /* Descriptor rings */
84 /* in vers >= 1.2, VIO_DRING_MODE is 0x04 and transfer mode is a bitmask */
85 #define VIO_NEW_DRING_MODE 0x04
87 struct vio_dring_data {
88 struct vio_msg_tag tag;
94 #define VIO_DRING_ACTIVE 0x01
95 #define VIO_DRING_STOPPED 0x02
103 struct vio_dring_hdr {
105 #define VIO_DESC_FREE 0x01
106 #define VIO_DESC_READY 0x02
107 #define VIO_DESC_ACCEPTED 0x03
108 #define VIO_DESC_DONE 0x04
110 #define VIO_ACK_ENABLE 0x01
111 #define VIO_ACK_DISABLE 0x00
117 /* VIO disk specific structures and defines */
118 struct vio_disk_attr_info {
119 struct vio_msg_tag tag;
122 #define VD_DISK_TYPE_SLICE 0x01 /* Slice in block device */
123 #define VD_DISK_TYPE_DISK 0x02 /* Entire block device */
124 u8 vdisk_mtype; /* v1.1 */
125 #define VD_MEDIA_TYPE_FIXED 0x01 /* Fixed device */
126 #define VD_MEDIA_TYPE_CD 0x02 /* CD Device */
127 #define VD_MEDIA_TYPE_DVD 0x03 /* DVD Device */
129 u32 vdisk_block_size;
131 u64 vdisk_size; /* v1.1 */
133 u32 phys_block_size; /* v1.2 */
138 struct vio_disk_desc {
139 struct vio_dring_hdr hdr;
142 #define VD_OP_BREAD 0x01 /* Block read */
143 #define VD_OP_BWRITE 0x02 /* Block write */
144 #define VD_OP_FLUSH 0x03 /* Flush disk contents */
145 #define VD_OP_GET_WCE 0x04 /* Get write-cache status */
146 #define VD_OP_SET_WCE 0x05 /* Enable/disable write-cache */
147 #define VD_OP_GET_VTOC 0x06 /* Get VTOC */
148 #define VD_OP_SET_VTOC 0x07 /* Set VTOC */
149 #define VD_OP_GET_DISKGEOM 0x08 /* Get disk geometry */
150 #define VD_OP_SET_DISKGEOM 0x09 /* Set disk geometry */
151 #define VD_OP_SCSICMD 0x0a /* SCSI control command */
152 #define VD_OP_GET_DEVID 0x0b /* Get device ID */
153 #define VD_OP_GET_EFI 0x0c /* Get EFI */
154 #define VD_OP_SET_EFI 0x0d /* Set EFI */
162 struct ldc_trans_cookie cookies[0];
165 #define VIO_DISK_VNAME_LEN 8
166 #define VIO_DISK_ALABEL_LEN 128
167 #define VIO_DISK_NUM_PART 8
169 struct vio_disk_vtoc {
170 u8 volume_name[VIO_DISK_VNAME_LEN];
173 u8 ascii_label[VIO_DISK_ALABEL_LEN];
180 } partitions[VIO_DISK_NUM_PART];
183 struct vio_disk_geom {
184 u16 num_cyl; /* Num data cylinders */
185 u16 alt_cyl; /* Num alternate cylinders */
186 u16 beg_cyl; /* Cyl off of fixed head area */
187 u16 num_hd; /* Num heads */
188 u16 num_sec; /* Num sectors */
189 u16 ifact; /* Interleave factor */
190 u16 apc; /* Alts per cylinder (SCSI) */
191 u16 rpm; /* Revolutions per minute */
192 u16 phy_cyl; /* Num physical cylinders */
193 u16 wr_skip; /* Num sects to skip, writes */
194 u16 rd_skip; /* Num sects to skip, writes */
197 struct vio_disk_devid {
204 struct vio_disk_efi {
210 /* VIO net specific structures and defines */
211 struct vio_net_attr_info {
212 struct vio_msg_tag tag;
215 #define VNET_ADDR_ETHERMAC 0x01
218 #define PHYSLINK_UPDATE_NONE 0x00
219 #define PHYSLINK_UPDATE_STATE 0x01
220 #define PHYSLINK_UPDATE_STATE_ACK 0x02
221 #define PHYSLINK_UPDATE_STATE_NACK 0x03
227 #define VNET_LSO_IPV4_CAPAB 0x0001
233 #define VNET_NUM_MCAST 7
235 struct vio_net_mcast_info {
236 struct vio_msg_tag tag;
239 u8 mcast_addr[VNET_NUM_MCAST * 6];
243 struct vio_net_desc {
244 struct vio_dring_hdr hdr;
247 struct ldc_trans_cookie cookies[0];
250 struct vio_net_dext {
252 #define VNET_PKT_HASH 0x01
253 #define VNET_PKT_HCK_IPV4_HDRCKSUM 0x02
254 #define VNET_PKT_HCK_FULLCKSUM 0x04
255 #define VNET_PKT_IPV4_LSO 0x08
256 #define VNET_PKT_HCK_IPV4_HDRCKSUM_OK 0x10
257 #define VNET_PKT_HCK_FULLCKSUM_OK 0x20
264 static inline struct vio_net_dext *vio_net_ext(struct vio_net_desc *desc)
266 return (struct vio_net_dext *)&desc->cookies[2];
269 #define VIO_MAX_RING_COOKIES 24
271 struct vio_dring_state {
282 struct ldc_trans_cookie cookies[VIO_MAX_RING_COOKIES];
285 static inline void *vio_dring_cur(struct vio_dring_state *dr)
287 return dr->base + (dr->entry_size * dr->prod);
290 static inline void *vio_dring_entry(struct vio_dring_state *dr,
293 return dr->base + (dr->entry_size * index);
296 static inline u32 vio_dring_avail(struct vio_dring_state *dr,
297 unsigned int ring_size)
299 return (dr->pending -
300 ((dr->prod - dr->cons) & (ring_size - 1)) - 1);
303 static inline u32 vio_dring_next(struct vio_dring_state *dr, u32 index)
305 if (++index == dr->num_entries)
310 static inline u32 vio_dring_prev(struct vio_dring_state *dr, u32 index)
313 return dr->num_entries - 1;
318 #define VIO_MAX_TYPE_LEN 32
319 #define VIO_MAX_COMPAT_LEN 64
323 struct device_node *dp;
325 char type[VIO_MAX_TYPE_LEN];
326 char compat[VIO_MAX_COMPAT_LEN];
332 unsigned long channel_id;
343 struct list_head node;
344 const struct vio_device_id *id_table;
345 int (*probe)(struct vio_dev *dev, const struct vio_device_id *id);
346 int (*remove)(struct vio_dev *dev);
347 void (*shutdown)(struct vio_dev *dev);
348 unsigned long driver_data;
349 struct device_driver driver;
357 struct vio_driver_state;
358 struct vio_driver_ops {
359 int (*send_attr)(struct vio_driver_state *vio);
360 int (*handle_attr)(struct vio_driver_state *vio, void *pkt);
361 void (*handshake_complete)(struct vio_driver_state *vio);
364 struct vio_completion {
365 struct completion com;
370 struct vio_driver_state {
371 /* Protects VIO handshake and, optionally, driver private state. */
374 struct ldc_channel *lp;
378 struct vio_dring_state drings[2];
379 #define VIO_DRIVER_TX_RING 0
380 #define VIO_DRIVER_RX_RING 1
383 #define VIO_HS_INVALID 0x00
384 #define VIO_HS_GOTVERS 0x01
385 #define VIO_HS_GOT_ATTR 0x04
386 #define VIO_HS_SENT_DREG 0x08
387 #define VIO_HS_SENT_RDX 0x10
388 #define VIO_HS_GOT_RDX_ACK 0x20
389 #define VIO_HS_GOT_RDX 0x40
390 #define VIO_HS_SENT_RDX_ACK 0x80
391 #define VIO_HS_COMPLETE (VIO_HS_GOT_RDX_ACK | VIO_HS_SENT_RDX_ACK)
396 #define VIO_DR_STATE_TXREG 0x01
397 #define VIO_DR_STATE_RXREG 0x02
398 #define VIO_DR_STATE_TXREQ 0x10
399 #define VIO_DR_STATE_RXREQ 0x20
402 #define VIO_DEBUG_HS 0x01
403 #define VIO_DEBUG_DATA 0x02
406 unsigned int desc_buf_len;
408 struct vio_completion *cmp;
410 struct vio_dev *vdev;
412 struct timer_list timer;
414 struct vio_version ver;
416 struct vio_version *ver_table;
417 int ver_table_entries;
421 struct vio_driver_ops *ops;
424 static inline bool vio_version_before(struct vio_driver_state *vio,
425 u16 major, u16 minor)
427 u32 have = (u32)vio->ver.major << 16 | vio->ver.minor;
428 u32 want = (u32)major << 16 | minor;
433 static inline bool vio_version_after(struct vio_driver_state *vio,
434 u16 major, u16 minor)
436 u32 have = (u32)vio->ver.major << 16 | vio->ver.minor;
437 u32 want = (u32)major << 16 | minor;
442 static inline bool vio_version_after_eq(struct vio_driver_state *vio,
443 u16 major, u16 minor)
445 u32 have = (u32)vio->ver.major << 16 | vio->ver.minor;
446 u32 want = (u32)major << 16 | minor;
451 #define viodbg(TYPE, f, a...) \
452 do { if (vio->debug & VIO_DEBUG_##TYPE) \
453 printk(KERN_INFO "vio: ID[%lu] " f, \
454 vio->vdev->channel_id, ## a); \
457 int __vio_register_driver(struct vio_driver *drv, struct module *owner,
458 const char *mod_name);
460 * vio_register_driver must be a macro so that KBUILD_MODNAME can be expanded
462 #define vio_register_driver(driver) \
463 __vio_register_driver(driver, THIS_MODULE, KBUILD_MODNAME)
464 void vio_unregister_driver(struct vio_driver *drv);
466 static inline struct vio_driver *to_vio_driver(struct device_driver *drv)
468 return container_of(drv, struct vio_driver, driver);
471 static inline struct vio_dev *to_vio_dev(struct device *dev)
473 return container_of(dev, struct vio_dev, dev);
476 int vio_ldc_send(struct vio_driver_state *vio, void *data, int len);
477 void vio_link_state_change(struct vio_driver_state *vio, int event);
478 void vio_conn_reset(struct vio_driver_state *vio);
479 int vio_control_pkt_engine(struct vio_driver_state *vio, void *pkt);
480 int vio_validate_sid(struct vio_driver_state *vio,
481 struct vio_msg_tag *tp);
482 u32 vio_send_sid(struct vio_driver_state *vio);
483 int vio_ldc_alloc(struct vio_driver_state *vio,
484 struct ldc_channel_config *base_cfg, void *event_arg);
485 void vio_ldc_free(struct vio_driver_state *vio);
486 int vio_driver_init(struct vio_driver_state *vio, struct vio_dev *vdev,
487 u8 dev_class, struct vio_version *ver_table,
488 int ver_table_size, struct vio_driver_ops *ops,
491 void vio_port_up(struct vio_driver_state *vio);
492 int vio_set_intr(unsigned long dev_ino, int state);
494 #endif /* _SPARC64_VIO_H */