1 #ifndef _SPARC64_VIO_H
2 #define _SPARC64_VIO_H
3
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>
12
13 #include <asm/ldc.h>
14 #include <asm/mdesc.h>
15
16 struct vio_msg_tag {
17 u8 type;
18 #define VIO_TYPE_CTRL 0x01
19 #define VIO_TYPE_DATA 0x02
20 #define VIO_TYPE_ERR 0x04
21
22 u8 stype;
23 #define VIO_SUBTYPE_INFO 0x01
24 #define VIO_SUBTYPE_ACK 0x02
25 #define VIO_SUBTYPE_NACK 0x04
26
27 u16 stype_env;
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
37
38 u32 sid;
39 };
40
41 struct vio_rdx {
42 struct vio_msg_tag tag;
43 u64 resv[6];
44 };
45
46 struct vio_ver_info {
47 struct vio_msg_tag tag;
48 u16 major;
49 u16 minor;
50 u8 dev_class;
51 #define VDEV_NETWORK 0x01
52 #define VDEV_NETWORK_SWITCH 0x02
53 #define VDEV_DISK 0x03
54 #define VDEV_DISK_SERVER 0x04
55
56 u8 resv1[3];
57 u64 resv2[5];
58 };
59
60 struct vio_dring_register {
61 struct vio_msg_tag tag;
62 u64 dring_ident;
63 u32 num_descr;
64 u32 descr_size;
65 u16 options;
66 #define VIO_TX_DRING 0x0001
67 #define VIO_RX_DRING 0x0002
68 #define VIO_RX_DRING_DATA 0x0004
69 u16 resv;
70 u32 num_cookies;
71 struct ldc_trans_cookie cookies[0];
72 };
73
74 struct vio_dring_unregister {
75 struct vio_msg_tag tag;
76 u64 dring_ident;
77 u64 resv[5];
78 };
79
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
86
87 struct vio_dring_data {
88 struct vio_msg_tag tag;
89 u64 seq;
90 u64 dring_ident;
91 u32 start_idx;
92 u32 end_idx;
93 u8 state;
94 #define VIO_DRING_ACTIVE 0x01
95 #define VIO_DRING_STOPPED 0x02
96
97 u8 __pad1;
98 u16 __pad2;
99 u32 __pad3;
100 u64 __par4[2];
101 };
102
103 struct vio_dring_hdr {
104 u8 state;
105 #define VIO_DESC_FREE 0x01
106 #define VIO_DESC_READY 0x02
107 #define VIO_DESC_ACCEPTED 0x03
108 #define VIO_DESC_DONE 0x04
109 u8 ack;
110 #define VIO_ACK_ENABLE 0x01
111 #define VIO_ACK_DISABLE 0x00
112
113 u16 __pad1;
114 u32 __pad2;
115 };
116
117 /* VIO disk specific structures and defines */
118 struct vio_disk_attr_info {
119 struct vio_msg_tag tag;
120 u8 xfer_mode;
121 u8 vdisk_type;
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 */
128 u8 resv1;
129 u32 vdisk_block_size;
130 u64 operations;
131 u64 vdisk_size; /* v1.1 */
132 u64 max_xfer_size;
133 u32 phys_block_size; /* v1.2 */
134 u32 resv2;
135 u64 resv3[1];
136 };
137
138 struct vio_disk_desc {
139 struct vio_dring_hdr hdr;
140 u64 req_id;
141 u8 operation;
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 */
155 u8 slice;
156 u16 resv1;
157 u32 status;
158 u64 offset;
159 u64 size;
160 u32 ncookies;
161 u32 resv2;
162 struct ldc_trans_cookie cookies[0];
163 };
164
165 #define VIO_DISK_VNAME_LEN 8
166 #define VIO_DISK_ALABEL_LEN 128
167 #define VIO_DISK_NUM_PART 8
168
169 struct vio_disk_vtoc {
170 u8 volume_name[VIO_DISK_VNAME_LEN];
171 u16 sector_size;
172 u16 num_partitions;
173 u8 ascii_label[VIO_DISK_ALABEL_LEN];
174 struct {
175 u16 id;
176 u16 perm_flags;
177 u32 resv;
178 u64 start_block;
179 u64 num_blocks;
180 } partitions[VIO_DISK_NUM_PART];
181 };
182
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 */
195 };
196
197 struct vio_disk_devid {
198 u16 resv;
199 u16 type;
200 u32 len;
201 char id[0];
202 };
203
204 struct vio_disk_efi {
205 u64 lba;
206 u64 len;
207 char data[0];
208 };
209
210 /* VIO net specific structures and defines */
211 struct vio_net_attr_info {
212 struct vio_msg_tag tag;
213 u8 xfer_mode;
214 u8 addr_type;
215 #define VNET_ADDR_ETHERMAC 0x01
216 u16 ack_freq;
217 u8 plnk_updt;
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
222 u8 options;
223 u16 resv1;
224 u64 addr;
225 u64 mtu;
226 u16 cflags;
227 #define VNET_LSO_IPV4_CAPAB 0x0001
228 u16 ipv4_lso_maxlen;
229 u32 resv2;
230 u64 resv3[2];
231 };
232
233 #define VNET_NUM_MCAST 7
234
235 struct vio_net_mcast_info {
236 struct vio_msg_tag tag;
237 u8 set;
238 u8 count;
239 u8 mcast_addr[VNET_NUM_MCAST * 6];
240 u32 resv;
241 };
242
243 struct vio_net_desc {
244 struct vio_dring_hdr hdr;
245 u32 size;
246 u32 ncookies;
247 struct ldc_trans_cookie cookies[0];
248 };
249
250 #define VIO_MAX_RING_COOKIES 24
251
252 struct vio_dring_state {
253 u64 ident;
254 void *base;
255 u64 snd_nxt;
256 u64 rcv_nxt;
257 u32 entry_size;
258 u32 num_entries;
259 u32 prod;
260 u32 cons;
261 u32 pending;
262 int ncookies;
263 struct ldc_trans_cookie cookies[VIO_MAX_RING_COOKIES];
264 };
265
vio_dring_cur(struct vio_dring_state * dr)266 static inline void *vio_dring_cur(struct vio_dring_state *dr)
267 {
268 return dr->base + (dr->entry_size * dr->prod);
269 }
270
vio_dring_entry(struct vio_dring_state * dr,unsigned int index)271 static inline void *vio_dring_entry(struct vio_dring_state *dr,
272 unsigned int index)
273 {
274 return dr->base + (dr->entry_size * index);
275 }
276
vio_dring_avail(struct vio_dring_state * dr,unsigned int ring_size)277 static inline u32 vio_dring_avail(struct vio_dring_state *dr,
278 unsigned int ring_size)
279 {
280 return (dr->pending -
281 ((dr->prod - dr->cons) & (ring_size - 1)) - 1);
282 }
283
284 #define VIO_MAX_TYPE_LEN 32
285 #define VIO_MAX_COMPAT_LEN 64
286
287 struct vio_dev {
288 u64 mp;
289 struct device_node *dp;
290
291 char type[VIO_MAX_TYPE_LEN];
292 char compat[VIO_MAX_COMPAT_LEN];
293 int compat_len;
294
295 u64 dev_no;
296
297 unsigned long channel_id;
298
299 unsigned int tx_irq;
300 unsigned int rx_irq;
301 u64 rx_ino;
302
303 struct device dev;
304 };
305
306 struct vio_driver {
307 const char *name;
308 struct list_head node;
309 const struct vio_device_id *id_table;
310 int (*probe)(struct vio_dev *dev, const struct vio_device_id *id);
311 int (*remove)(struct vio_dev *dev);
312 void (*shutdown)(struct vio_dev *dev);
313 unsigned long driver_data;
314 struct device_driver driver;
315 };
316
317 struct vio_version {
318 u16 major;
319 u16 minor;
320 };
321
322 struct vio_driver_state;
323 struct vio_driver_ops {
324 int (*send_attr)(struct vio_driver_state *vio);
325 int (*handle_attr)(struct vio_driver_state *vio, void *pkt);
326 void (*handshake_complete)(struct vio_driver_state *vio);
327 };
328
329 struct vio_completion {
330 struct completion com;
331 int err;
332 int waiting_for;
333 };
334
335 struct vio_driver_state {
336 /* Protects VIO handshake and, optionally, driver private state. */
337 spinlock_t lock;
338
339 struct ldc_channel *lp;
340
341 u32 _peer_sid;
342 u32 _local_sid;
343 struct vio_dring_state drings[2];
344 #define VIO_DRIVER_TX_RING 0
345 #define VIO_DRIVER_RX_RING 1
346
347 u8 hs_state;
348 #define VIO_HS_INVALID 0x00
349 #define VIO_HS_GOTVERS 0x01
350 #define VIO_HS_GOT_ATTR 0x04
351 #define VIO_HS_SENT_DREG 0x08
352 #define VIO_HS_SENT_RDX 0x10
353 #define VIO_HS_GOT_RDX_ACK 0x20
354 #define VIO_HS_GOT_RDX 0x40
355 #define VIO_HS_SENT_RDX_ACK 0x80
356 #define VIO_HS_COMPLETE (VIO_HS_GOT_RDX_ACK | VIO_HS_SENT_RDX_ACK)
357
358 u8 dev_class;
359
360 u8 dr_state;
361 #define VIO_DR_STATE_TXREG 0x01
362 #define VIO_DR_STATE_RXREG 0x02
363 #define VIO_DR_STATE_TXREQ 0x10
364 #define VIO_DR_STATE_RXREQ 0x20
365
366 u8 debug;
367 #define VIO_DEBUG_HS 0x01
368 #define VIO_DEBUG_DATA 0x02
369
370 void *desc_buf;
371 unsigned int desc_buf_len;
372
373 struct vio_completion *cmp;
374
375 struct vio_dev *vdev;
376
377 struct timer_list timer;
378
379 struct vio_version ver;
380
381 struct vio_version *ver_table;
382 int ver_table_entries;
383
384 char *name;
385
386 struct vio_driver_ops *ops;
387 };
388
vio_version_before(struct vio_driver_state * vio,u16 major,u16 minor)389 static inline bool vio_version_before(struct vio_driver_state *vio,
390 u16 major, u16 minor)
391 {
392 u32 have = (u32)vio->ver.major << 16 | vio->ver.minor;
393 u32 want = (u32)major << 16 | minor;
394
395 return have < want;
396 }
397
vio_version_after(struct vio_driver_state * vio,u16 major,u16 minor)398 static inline bool vio_version_after(struct vio_driver_state *vio,
399 u16 major, u16 minor)
400 {
401 u32 have = (u32)vio->ver.major << 16 | vio->ver.minor;
402 u32 want = (u32)major << 16 | minor;
403
404 return have > want;
405 }
406
vio_version_after_eq(struct vio_driver_state * vio,u16 major,u16 minor)407 static inline bool vio_version_after_eq(struct vio_driver_state *vio,
408 u16 major, u16 minor)
409 {
410 u32 have = (u32)vio->ver.major << 16 | vio->ver.minor;
411 u32 want = (u32)major << 16 | minor;
412
413 return have >= want;
414 }
415
416 #define viodbg(TYPE, f, a...) \
417 do { if (vio->debug & VIO_DEBUG_##TYPE) \
418 printk(KERN_INFO "vio: ID[%lu] " f, \
419 vio->vdev->channel_id, ## a); \
420 } while (0)
421
422 int __vio_register_driver(struct vio_driver *drv, struct module *owner,
423 const char *mod_name);
424 /*
425 * vio_register_driver must be a macro so that KBUILD_MODNAME can be expanded
426 */
427 #define vio_register_driver(driver) \
428 __vio_register_driver(driver, THIS_MODULE, KBUILD_MODNAME)
429 void vio_unregister_driver(struct vio_driver *drv);
430
to_vio_driver(struct device_driver * drv)431 static inline struct vio_driver *to_vio_driver(struct device_driver *drv)
432 {
433 return container_of(drv, struct vio_driver, driver);
434 }
435
to_vio_dev(struct device * dev)436 static inline struct vio_dev *to_vio_dev(struct device *dev)
437 {
438 return container_of(dev, struct vio_dev, dev);
439 }
440
441 int vio_ldc_send(struct vio_driver_state *vio, void *data, int len);
442 void vio_link_state_change(struct vio_driver_state *vio, int event);
443 void vio_conn_reset(struct vio_driver_state *vio);
444 int vio_control_pkt_engine(struct vio_driver_state *vio, void *pkt);
445 int vio_validate_sid(struct vio_driver_state *vio,
446 struct vio_msg_tag *tp);
447 u32 vio_send_sid(struct vio_driver_state *vio);
448 int vio_ldc_alloc(struct vio_driver_state *vio,
449 struct ldc_channel_config *base_cfg, void *event_arg);
450 void vio_ldc_free(struct vio_driver_state *vio);
451 int vio_driver_init(struct vio_driver_state *vio, struct vio_dev *vdev,
452 u8 dev_class, struct vio_version *ver_table,
453 int ver_table_size, struct vio_driver_ops *ops,
454 char *name);
455
456 void vio_port_up(struct vio_driver_state *vio);
457 int vio_set_intr(unsigned long dev_ino, int state);
458
459 #endif /* _SPARC64_VIO_H */
460