1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _SPARC64_VIO_H
3 #define _SPARC64_VIO_H
4
5 #include <linux/kernel.h>
6 #include <linux/device.h>
7 #include <linux/mod_devicetable.h>
8 #include <linux/timer.h>
9 #include <linux/spinlock.h>
10 #include <linux/completion.h>
11 #include <linux/list.h>
12 #include <linux/log2.h>
13
14 #include <asm/ldc.h>
15 #include <asm/mdesc.h>
16
17 struct vio_msg_tag {
18 u8 type;
19 #define VIO_TYPE_CTRL 0x01
20 #define VIO_TYPE_DATA 0x02
21 #define VIO_TYPE_ERR 0x04
22
23 u8 stype;
24 #define VIO_SUBTYPE_INFO 0x01
25 #define VIO_SUBTYPE_ACK 0x02
26 #define VIO_SUBTYPE_NACK 0x04
27
28 u16 stype_env;
29 #define VIO_VER_INFO 0x0001
30 #define VIO_ATTR_INFO 0x0002
31 #define VIO_DRING_REG 0x0003
32 #define VIO_DRING_UNREG 0x0004
33 #define VIO_RDX 0x0005
34 #define VIO_PKT_DATA 0x0040
35 #define VIO_DESC_DATA 0x0041
36 #define VIO_DRING_DATA 0x0042
37 #define VNET_MCAST_INFO 0x0101
38
39 u32 sid;
40 };
41
42 struct vio_rdx {
43 struct vio_msg_tag tag;
44 u64 resv[6];
45 };
46
47 struct vio_ver_info {
48 struct vio_msg_tag tag;
49 u16 major;
50 u16 minor;
51 u8 dev_class;
52 #define VDEV_NETWORK 0x01
53 #define VDEV_NETWORK_SWITCH 0x02
54 #define VDEV_DISK 0x03
55 #define VDEV_DISK_SERVER 0x04
56 #define VDEV_CONSOLE_CON 0x05
57
58 u8 resv1[3];
59 u64 resv2[5];
60 };
61
62 struct vio_dring_register {
63 struct vio_msg_tag tag;
64 u64 dring_ident;
65 u32 num_descr;
66 u32 descr_size;
67 u16 options;
68 #define VIO_TX_DRING 0x0001
69 #define VIO_RX_DRING 0x0002
70 #define VIO_RX_DRING_DATA 0x0004
71 u16 resv;
72 u32 num_cookies;
73 struct ldc_trans_cookie cookies[0];
74 };
75
76 struct vio_dring_unregister {
77 struct vio_msg_tag tag;
78 u64 dring_ident;
79 u64 resv[5];
80 };
81
82 /* Data transfer modes */
83 #define VIO_PKT_MODE 0x01 /* Packet based transfer */
84 #define VIO_DESC_MODE 0x02 /* In-band descriptors */
85 #define VIO_DRING_MODE 0x03 /* Descriptor rings */
86 /* in vers >= 1.2, VIO_DRING_MODE is 0x04 and transfer mode is a bitmask */
87 #define VIO_NEW_DRING_MODE 0x04
88
89 struct vio_dring_data {
90 struct vio_msg_tag tag;
91 u64 seq;
92 u64 dring_ident;
93 u32 start_idx;
94 u32 end_idx;
95 u8 state;
96 #define VIO_DRING_ACTIVE 0x01
97 #define VIO_DRING_STOPPED 0x02
98
99 u8 __pad1;
100 u16 __pad2;
101 u32 __pad3;
102 u64 __par4[2];
103 };
104
105 struct vio_dring_hdr {
106 u8 state;
107 #define VIO_DESC_FREE 0x01
108 #define VIO_DESC_READY 0x02
109 #define VIO_DESC_ACCEPTED 0x03
110 #define VIO_DESC_DONE 0x04
111 u8 ack;
112 #define VIO_ACK_ENABLE 0x01
113 #define VIO_ACK_DISABLE 0x00
114
115 u16 __pad1;
116 u32 __pad2;
117 };
118
119 /* VIO disk specific structures and defines */
120 struct vio_disk_attr_info {
121 struct vio_msg_tag tag;
122 u8 xfer_mode;
123 u8 vdisk_type;
124 #define VD_DISK_TYPE_SLICE 0x01 /* Slice in block device */
125 #define VD_DISK_TYPE_DISK 0x02 /* Entire block device */
126 u8 vdisk_mtype; /* v1.1 */
127 #define VD_MEDIA_TYPE_FIXED 0x01 /* Fixed device */
128 #define VD_MEDIA_TYPE_CD 0x02 /* CD Device */
129 #define VD_MEDIA_TYPE_DVD 0x03 /* DVD Device */
130 u8 resv1;
131 u32 vdisk_block_size;
132 u64 operations;
133 u64 vdisk_size; /* v1.1 */
134 u64 max_xfer_size;
135 u32 phys_block_size; /* v1.2 */
136 u32 resv2;
137 u64 resv3[1];
138 };
139
140 struct vio_disk_desc {
141 struct vio_dring_hdr hdr;
142 u64 req_id;
143 u8 operation;
144 #define VD_OP_BREAD 0x01 /* Block read */
145 #define VD_OP_BWRITE 0x02 /* Block write */
146 #define VD_OP_FLUSH 0x03 /* Flush disk contents */
147 #define VD_OP_GET_WCE 0x04 /* Get write-cache status */
148 #define VD_OP_SET_WCE 0x05 /* Enable/disable write-cache */
149 #define VD_OP_GET_VTOC 0x06 /* Get VTOC */
150 #define VD_OP_SET_VTOC 0x07 /* Set VTOC */
151 #define VD_OP_GET_DISKGEOM 0x08 /* Get disk geometry */
152 #define VD_OP_SET_DISKGEOM 0x09 /* Set disk geometry */
153 #define VD_OP_SCSICMD 0x0a /* SCSI control command */
154 #define VD_OP_GET_DEVID 0x0b /* Get device ID */
155 #define VD_OP_GET_EFI 0x0c /* Get EFI */
156 #define VD_OP_SET_EFI 0x0d /* Set EFI */
157 u8 slice;
158 u16 resv1;
159 u32 status;
160 u64 offset;
161 u64 size;
162 u32 ncookies;
163 u32 resv2;
164 struct ldc_trans_cookie cookies[0];
165 };
166
167 #define VIO_DISK_VNAME_LEN 8
168 #define VIO_DISK_ALABEL_LEN 128
169 #define VIO_DISK_NUM_PART 8
170
171 struct vio_disk_vtoc {
172 u8 volume_name[VIO_DISK_VNAME_LEN];
173 u16 sector_size;
174 u16 num_partitions;
175 u8 ascii_label[VIO_DISK_ALABEL_LEN];
176 struct {
177 u16 id;
178 u16 perm_flags;
179 u32 resv;
180 u64 start_block;
181 u64 num_blocks;
182 } partitions[VIO_DISK_NUM_PART];
183 };
184
185 struct vio_disk_geom {
186 u16 num_cyl; /* Num data cylinders */
187 u16 alt_cyl; /* Num alternate cylinders */
188 u16 beg_cyl; /* Cyl off of fixed head area */
189 u16 num_hd; /* Num heads */
190 u16 num_sec; /* Num sectors */
191 u16 ifact; /* Interleave factor */
192 u16 apc; /* Alts per cylinder (SCSI) */
193 u16 rpm; /* Revolutions per minute */
194 u16 phy_cyl; /* Num physical cylinders */
195 u16 wr_skip; /* Num sects to skip, writes */
196 u16 rd_skip; /* Num sects to skip, writes */
197 };
198
199 struct vio_disk_devid {
200 u16 resv;
201 u16 type;
202 u32 len;
203 char id[0];
204 };
205
206 struct vio_disk_efi {
207 u64 lba;
208 u64 len;
209 char data[0];
210 };
211
212 /* VIO net specific structures and defines */
213 struct vio_net_attr_info {
214 struct vio_msg_tag tag;
215 u8 xfer_mode;
216 u8 addr_type;
217 #define VNET_ADDR_ETHERMAC 0x01
218 u16 ack_freq;
219 u8 plnk_updt;
220 #define PHYSLINK_UPDATE_NONE 0x00
221 #define PHYSLINK_UPDATE_STATE 0x01
222 #define PHYSLINK_UPDATE_STATE_ACK 0x02
223 #define PHYSLINK_UPDATE_STATE_NACK 0x03
224 u8 options;
225 u16 resv1;
226 u64 addr;
227 u64 mtu;
228 u16 cflags;
229 #define VNET_LSO_IPV4_CAPAB 0x0001
230 u16 ipv4_lso_maxlen;
231 u32 resv2;
232 u64 resv3[2];
233 };
234
235 #define VNET_NUM_MCAST 7
236
237 struct vio_net_mcast_info {
238 struct vio_msg_tag tag;
239 u8 set;
240 u8 count;
241 u8 mcast_addr[VNET_NUM_MCAST * 6];
242 u32 resv;
243 };
244
245 struct vio_net_desc {
246 struct vio_dring_hdr hdr;
247 u32 size;
248 u32 ncookies;
249 struct ldc_trans_cookie cookies[0];
250 };
251
252 struct vio_net_dext {
253 u8 flags;
254 #define VNET_PKT_HASH 0x01
255 #define VNET_PKT_HCK_IPV4_HDRCKSUM 0x02
256 #define VNET_PKT_HCK_FULLCKSUM 0x04
257 #define VNET_PKT_IPV4_LSO 0x08
258 #define VNET_PKT_HCK_IPV4_HDRCKSUM_OK 0x10
259 #define VNET_PKT_HCK_FULLCKSUM_OK 0x20
260
261 u8 vnet_hashval;
262 u16 ipv4_lso_mss;
263 u32 resv3;
264 };
265
vio_net_ext(struct vio_net_desc * desc)266 static inline struct vio_net_dext *vio_net_ext(struct vio_net_desc *desc)
267 {
268 return (struct vio_net_dext *)&desc->cookies[2];
269 }
270
271 #define VIO_MAX_RING_COOKIES 24
272
273 struct vio_dring_state {
274 u64 ident;
275 void *base;
276 u64 snd_nxt;
277 u64 rcv_nxt;
278 u32 entry_size;
279 u32 num_entries;
280 u32 prod;
281 u32 cons;
282 u32 pending;
283 int ncookies;
284 struct ldc_trans_cookie cookies[VIO_MAX_RING_COOKIES];
285 };
286
287 #define VIO_TAG_SIZE ((int)sizeof(struct vio_msg_tag))
288 #define VIO_VCC_MTU_SIZE (LDC_PACKET_SIZE - VIO_TAG_SIZE)
289
290 struct vio_vcc {
291 struct vio_msg_tag tag;
292 char data[VIO_VCC_MTU_SIZE];
293 };
294
vio_dring_cur(struct vio_dring_state * dr)295 static inline void *vio_dring_cur(struct vio_dring_state *dr)
296 {
297 return dr->base + (dr->entry_size * dr->prod);
298 }
299
vio_dring_entry(struct vio_dring_state * dr,unsigned int index)300 static inline void *vio_dring_entry(struct vio_dring_state *dr,
301 unsigned int index)
302 {
303 return dr->base + (dr->entry_size * index);
304 }
305
vio_dring_avail(struct vio_dring_state * dr,unsigned int ring_size)306 static inline u32 vio_dring_avail(struct vio_dring_state *dr,
307 unsigned int ring_size)
308 {
309 return (dr->pending -
310 ((dr->prod - dr->cons) & (ring_size - 1)) - 1);
311 }
312
vio_dring_next(struct vio_dring_state * dr,u32 index)313 static inline u32 vio_dring_next(struct vio_dring_state *dr, u32 index)
314 {
315 if (++index == dr->num_entries)
316 index = 0;
317 return index;
318 }
319
vio_dring_prev(struct vio_dring_state * dr,u32 index)320 static inline u32 vio_dring_prev(struct vio_dring_state *dr, u32 index)
321 {
322 if (index == 0)
323 return dr->num_entries - 1;
324 else
325 return index - 1;
326 }
327
328 #define VIO_MAX_TYPE_LEN 32
329 #define VIO_MAX_NAME_LEN 32
330 #define VIO_MAX_COMPAT_LEN 64
331
332 struct vio_dev {
333 u64 mp;
334 struct device_node *dp;
335
336 char node_name[VIO_MAX_NAME_LEN];
337 char type[VIO_MAX_TYPE_LEN];
338 char compat[VIO_MAX_COMPAT_LEN];
339 int compat_len;
340
341 u64 dev_no;
342
343 unsigned long port_id;
344 unsigned long channel_id;
345
346 unsigned int tx_irq;
347 unsigned int rx_irq;
348 u64 rx_ino;
349 u64 tx_ino;
350
351 /* Handle to the root of "channel-devices" sub-tree in MDESC */
352 u64 cdev_handle;
353
354 /* MD specific data used to identify the vdev in MD */
355 union md_node_info md_node_info;
356
357 struct device dev;
358 };
359
360 struct vio_driver {
361 const char *name;
362 struct list_head node;
363 const struct vio_device_id *id_table;
364 int (*probe)(struct vio_dev *dev, const struct vio_device_id *id);
365 int (*remove)(struct vio_dev *dev);
366 void (*shutdown)(struct vio_dev *dev);
367 unsigned long driver_data;
368 struct device_driver driver;
369 bool no_irq;
370 };
371
372 struct vio_version {
373 u16 major;
374 u16 minor;
375 };
376
377 struct vio_driver_state;
378 struct vio_driver_ops {
379 int (*send_attr)(struct vio_driver_state *vio);
380 int (*handle_attr)(struct vio_driver_state *vio, void *pkt);
381 void (*handshake_complete)(struct vio_driver_state *vio);
382 };
383
384 struct vio_completion {
385 struct completion com;
386 int err;
387 int waiting_for;
388 };
389
390 struct vio_driver_state {
391 /* Protects VIO handshake and, optionally, driver private state. */
392 spinlock_t lock;
393
394 struct ldc_channel *lp;
395
396 u32 _peer_sid;
397 u32 _local_sid;
398 struct vio_dring_state drings[2];
399 #define VIO_DRIVER_TX_RING 0
400 #define VIO_DRIVER_RX_RING 1
401
402 u8 hs_state;
403 #define VIO_HS_INVALID 0x00
404 #define VIO_HS_GOTVERS 0x01
405 #define VIO_HS_GOT_ATTR 0x04
406 #define VIO_HS_SENT_DREG 0x08
407 #define VIO_HS_SENT_RDX 0x10
408 #define VIO_HS_GOT_RDX_ACK 0x20
409 #define VIO_HS_GOT_RDX 0x40
410 #define VIO_HS_SENT_RDX_ACK 0x80
411 #define VIO_HS_COMPLETE (VIO_HS_GOT_RDX_ACK | VIO_HS_SENT_RDX_ACK)
412
413 u8 dev_class;
414
415 u8 dr_state;
416 #define VIO_DR_STATE_TXREG 0x01
417 #define VIO_DR_STATE_RXREG 0x02
418 #define VIO_DR_STATE_TXREQ 0x10
419 #define VIO_DR_STATE_RXREQ 0x20
420
421 u8 debug;
422 #define VIO_DEBUG_HS 0x01
423 #define VIO_DEBUG_DATA 0x02
424
425 void *desc_buf;
426 unsigned int desc_buf_len;
427
428 struct vio_completion *cmp;
429
430 struct vio_dev *vdev;
431
432 struct timer_list timer;
433
434 struct vio_version ver;
435
436 struct vio_version *ver_table;
437 int ver_table_entries;
438
439 char *name;
440
441 struct vio_driver_ops *ops;
442 };
443
vio_version_before(struct vio_driver_state * vio,u16 major,u16 minor)444 static inline bool vio_version_before(struct vio_driver_state *vio,
445 u16 major, u16 minor)
446 {
447 u32 have = (u32)vio->ver.major << 16 | vio->ver.minor;
448 u32 want = (u32)major << 16 | minor;
449
450 return have < want;
451 }
452
vio_version_after(struct vio_driver_state * vio,u16 major,u16 minor)453 static inline bool vio_version_after(struct vio_driver_state *vio,
454 u16 major, u16 minor)
455 {
456 u32 have = (u32)vio->ver.major << 16 | vio->ver.minor;
457 u32 want = (u32)major << 16 | minor;
458
459 return have > want;
460 }
461
vio_version_after_eq(struct vio_driver_state * vio,u16 major,u16 minor)462 static inline bool vio_version_after_eq(struct vio_driver_state *vio,
463 u16 major, u16 minor)
464 {
465 u32 have = (u32)vio->ver.major << 16 | vio->ver.minor;
466 u32 want = (u32)major << 16 | minor;
467
468 return have >= want;
469 }
470
471 #define viodbg(TYPE, f, a...) \
472 do { if (vio->debug & VIO_DEBUG_##TYPE) \
473 printk(KERN_INFO "vio: ID[%lu] " f, \
474 vio->vdev->channel_id, ## a); \
475 } while (0)
476
477 int __vio_register_driver(struct vio_driver *drv, struct module *owner,
478 const char *mod_name);
479 /*
480 * vio_register_driver must be a macro so that KBUILD_MODNAME can be expanded
481 */
482 #define vio_register_driver(driver) \
483 __vio_register_driver(driver, THIS_MODULE, KBUILD_MODNAME)
484 void vio_unregister_driver(struct vio_driver *drv);
485
to_vio_driver(struct device_driver * drv)486 static inline struct vio_driver *to_vio_driver(struct device_driver *drv)
487 {
488 return container_of(drv, struct vio_driver, driver);
489 }
490
to_vio_dev(struct device * dev)491 static inline struct vio_dev *to_vio_dev(struct device *dev)
492 {
493 return container_of(dev, struct vio_dev, dev);
494 }
495
496 int vio_ldc_send(struct vio_driver_state *vio, void *data, int len);
497 void vio_link_state_change(struct vio_driver_state *vio, int event);
498 void vio_conn_reset(struct vio_driver_state *vio);
499 int vio_control_pkt_engine(struct vio_driver_state *vio, void *pkt);
500 int vio_validate_sid(struct vio_driver_state *vio,
501 struct vio_msg_tag *tp);
502 u32 vio_send_sid(struct vio_driver_state *vio);
503 int vio_ldc_alloc(struct vio_driver_state *vio,
504 struct ldc_channel_config *base_cfg, void *event_arg);
505 void vio_ldc_free(struct vio_driver_state *vio);
506 int vio_driver_init(struct vio_driver_state *vio, struct vio_dev *vdev,
507 u8 dev_class, struct vio_version *ver_table,
508 int ver_table_size, struct vio_driver_ops *ops,
509 char *name);
510
511 void vio_port_up(struct vio_driver_state *vio);
512 int vio_set_intr(unsigned long dev_ino, int state);
513 u64 vio_vdev_node(struct mdesc_handle *hp, struct vio_dev *vdev);
514
515 #endif /* _SPARC64_VIO_H */
516
