1 /* 2 * Copyright (c) 2014-2015 Hisilicon Limited. 3 * 4 * This program is free software; you can redistribute it and/or modify 5 * it under the terms of the GNU General Public License as published by 6 * the Free Software Foundation; either version 2 of the License, or 7 * (at your option) any later version. 8 */ 9 10 #ifndef __HNAE_H 11 #define __HNAE_H 12 13 /* Names used in this framework: 14 * ae handle (handle): 15 * a set of queues provided by AE 16 * ring buffer queue (rbq): 17 * the channel between upper layer and the AE, can do tx and rx 18 * ring: 19 * a tx or rx channel within a rbq 20 * ring description (desc): 21 * an element in the ring with packet information 22 * buffer: 23 * a memory region referred by desc with the full packet payload 24 * 25 * "num" means a static number set as a parameter, "count" mean a dynamic 26 * number set while running 27 * "cb" means control block 28 */ 29 30 #include <linux/delay.h> 31 #include <linux/device.h> 32 #include <linux/module.h> 33 #include <linux/netdevice.h> 34 #include <linux/notifier.h> 35 #include <linux/types.h> 36 37 #define HNAE_DRIVER_VERSION "1.3.0" 38 #define HNAE_DRIVER_NAME "hns" 39 #define HNAE_COPYRIGHT "Copyright(c) 2015 Huawei Corporation." 40 #define HNAE_DRIVER_STRING "Hisilicon Network Subsystem Driver" 41 #define HNAE_DEFAULT_DEVICE_DESCR "Hisilicon Network Subsystem" 42 43 #ifdef DEBUG 44 45 #ifndef assert 46 #define assert(expr) \ 47 do { \ 48 if (!(expr)) { \ 49 pr_err("Assertion failed! %s, %s, %s, line %d\n", \ 50 #expr, __FILE__, __func__, __LINE__); \ 51 } \ 52 } while (0) 53 #endif 54 55 #else 56 57 #ifndef assert 58 #define assert(expr) 59 #endif 60 61 #endif 62 63 #define AE_VERSION_1 ('6' << 16 | '6' << 8 | '0') 64 #define AE_VERSION_2 ('1' << 24 | '6' << 16 | '1' << 8 | '0') 65 #define AE_NAME_SIZE 16 66 67 /* some said the RX and TX RCB format should not be the same in the future. But 68 * it is the same now... 69 */ 70 #define RCB_REG_BASEADDR_L 0x00 /* P660 support only 32bit accessing */ 71 #define RCB_REG_BASEADDR_H 0x04 72 #define RCB_REG_BD_NUM 0x08 73 #define RCB_REG_BD_LEN 0x0C 74 #define RCB_REG_PKTLINE 0x10 75 #define RCB_REG_TAIL 0x18 76 #define RCB_REG_HEAD 0x1C 77 #define RCB_REG_FBDNUM 0x20 78 #define RCB_REG_OFFSET 0x24 /* pkt num to be handled */ 79 #define RCB_REG_PKTNUM_RECORD 0x2C /* total pkt received */ 80 81 #define HNS_RX_HEAD_SIZE 256 82 83 #define HNAE_AE_REGISTER 0x1 84 85 #define RCB_RING_NAME_LEN 16 86 87 enum hnae_led_state { 88 HNAE_LED_INACTIVE, 89 HNAE_LED_ACTIVE, 90 HNAE_LED_ON, 91 HNAE_LED_OFF 92 }; 93 94 #define HNS_RX_FLAG_VLAN_PRESENT 0x1 95 #define HNS_RX_FLAG_L3ID_IPV4 0x0 96 #define HNS_RX_FLAG_L3ID_IPV6 0x1 97 #define HNS_RX_FLAG_L4ID_UDP 0x0 98 #define HNS_RX_FLAG_L4ID_TCP 0x1 99 100 #define HNS_TXD_ASID_S 0 101 #define HNS_TXD_ASID_M (0xff << HNS_TXD_ASID_S) 102 #define HNS_TXD_BUFNUM_S 8 103 #define HNS_TXD_BUFNUM_M (0x3 << HNS_TXD_BUFNUM_S) 104 #define HNS_TXD_PORTID_S 10 105 #define HNS_TXD_PORTID_M (0x7 << HNS_TXD_PORTID_S) 106 107 #define HNS_TXD_RA_B 8 108 #define HNS_TXD_RI_B 9 109 #define HNS_TXD_L4CS_B 10 110 #define HNS_TXD_L3CS_B 11 111 #define HNS_TXD_FE_B 12 112 #define HNS_TXD_VLD_B 13 113 #define HNS_TXD_IPOFFSET_S 14 114 #define HNS_TXD_IPOFFSET_M (0xff << HNS_TXD_IPOFFSET_S) 115 116 #define HNS_RXD_IPOFFSET_S 0 117 #define HNS_RXD_IPOFFSET_M (0xff << HNS_TXD_IPOFFSET_S) 118 #define HNS_RXD_BUFNUM_S 8 119 #define HNS_RXD_BUFNUM_M (0x3 << HNS_RXD_BUFNUM_S) 120 #define HNS_RXD_PORTID_S 10 121 #define HNS_RXD_PORTID_M (0x7 << HNS_RXD_PORTID_S) 122 #define HNS_RXD_DMAC_S 13 123 #define HNS_RXD_DMAC_M (0x3 << HNS_RXD_DMAC_S) 124 #define HNS_RXD_VLAN_S 15 125 #define HNS_RXD_VLAN_M (0x3 << HNS_RXD_VLAN_S) 126 #define HNS_RXD_L3ID_S 17 127 #define HNS_RXD_L3ID_M (0xf << HNS_RXD_L3ID_S) 128 #define HNS_RXD_L4ID_S 21 129 #define HNS_RXD_L4ID_M (0xf << HNS_RXD_L4ID_S) 130 #define HNS_RXD_FE_B 25 131 #define HNS_RXD_FRAG_B 26 132 #define HNS_RXD_VLD_B 27 133 #define HNS_RXD_L2E_B 28 134 #define HNS_RXD_L3E_B 29 135 #define HNS_RXD_L4E_B 30 136 #define HNS_RXD_DROP_B 31 137 138 #define HNS_RXD_VLANID_S 8 139 #define HNS_RXD_VLANID_M (0xfff << HNS_RXD_VLANID_S) 140 #define HNS_RXD_CFI_B 20 141 #define HNS_RXD_PRI_S 21 142 #define HNS_RXD_PRI_M (0x7 << HNS_RXD_PRI_S) 143 #define HNS_RXD_ASID_S 24 144 #define HNS_RXD_ASID_M (0xff << HNS_RXD_ASID_S) 145 146 /* hardware spec ring buffer format */ 147 struct __packed hnae_desc { 148 __le64 addr; 149 union { 150 struct { 151 __le16 asid_bufnum_pid; 152 __le16 send_size; 153 __le32 flag_ipoffset; 154 __le32 reserved_3[4]; 155 } tx; 156 157 struct { 158 __le32 ipoff_bnum_pid_flag; 159 __le16 pkt_len; 160 __le16 size; 161 __le32 vlan_pri_asid; 162 __le32 reserved_2[3]; 163 } rx; 164 }; 165 }; 166 167 struct hnae_desc_cb { 168 dma_addr_t dma; /* dma address of this desc */ 169 void *buf; /* cpu addr for a desc */ 170 171 /* priv data for the desc, e.g. skb when use with ip stack*/ 172 void *priv; 173 u16 page_offset; 174 u16 reuse_flag; 175 176 u16 length; /* length of the buffer */ 177 178 /* desc type, used by the ring user to mark the type of the priv data */ 179 u16 type; 180 }; 181 182 #define setflags(flags, bits) ((flags) |= (bits)) 183 #define unsetflags(flags, bits) ((flags) &= ~(bits)) 184 185 /* hnae_ring->flags fields */ 186 #define RINGF_DIR 0x1 /* TX or RX ring, set if TX */ 187 #define is_tx_ring(ring) ((ring)->flags & RINGF_DIR) 188 #define is_rx_ring(ring) (!is_tx_ring(ring)) 189 #define ring_to_dma_dir(ring) (is_tx_ring(ring) ? \ 190 DMA_TO_DEVICE : DMA_FROM_DEVICE) 191 192 struct ring_stats { 193 u64 io_err_cnt; 194 u64 sw_err_cnt; 195 u64 seg_pkt_cnt; 196 union { 197 struct { 198 u64 tx_pkts; 199 u64 tx_bytes; 200 u64 tx_err_cnt; 201 u64 restart_queue; 202 u64 tx_busy; 203 }; 204 struct { 205 u64 rx_pkts; 206 u64 rx_bytes; 207 u64 rx_err_cnt; 208 u64 reuse_pg_cnt; 209 u64 err_pkt_len; 210 u64 non_vld_descs; 211 u64 err_bd_num; 212 u64 l2_err; 213 u64 l3l4_csum_err; 214 }; 215 }; 216 }; 217 218 struct hnae_queue; 219 220 struct hnae_ring { 221 u8 __iomem *io_base; /* base io address for the ring */ 222 struct hnae_desc *desc; /* dma map address space */ 223 struct hnae_desc_cb *desc_cb; 224 struct hnae_queue *q; 225 int irq; 226 char ring_name[RCB_RING_NAME_LEN]; 227 228 /* statistic */ 229 struct ring_stats stats; 230 231 dma_addr_t desc_dma_addr; 232 u32 buf_size; /* size for hnae_desc->addr, preset by AE */ 233 u16 desc_num; /* total number of desc */ 234 u16 max_desc_num_per_pkt; 235 u16 max_raw_data_sz_per_desc; 236 u16 max_pkt_size; 237 int next_to_use; /* idx of next spare desc */ 238 239 /* idx of lastest sent desc, the ring is empty when equal to 240 * next_to_use 241 */ 242 int next_to_clean; 243 244 int flags; /* ring attribute */ 245 int irq_init_flag; 246 }; 247 248 #define ring_ptr_move_fw(ring, p) \ 249 ((ring)->p = ((ring)->p + 1) % (ring)->desc_num) 250 #define ring_ptr_move_bw(ring, p) \ 251 ((ring)->p = ((ring)->p - 1 + (ring)->desc_num) % (ring)->desc_num) 252 253 enum hns_desc_type { 254 DESC_TYPE_SKB, 255 DESC_TYPE_PAGE, 256 }; 257 258 #define assert_is_ring_idx(ring, idx) \ 259 assert((idx) >= 0 && (idx) < (ring)->desc_num) 260 261 /* the distance between [begin, end) in a ring buffer 262 * note: there is a unuse slot between the begin and the end 263 */ 264 static inline int ring_dist(struct hnae_ring *ring, int begin, int end) 265 { 266 assert_is_ring_idx(ring, begin); 267 assert_is_ring_idx(ring, end); 268 269 return (end - begin + ring->desc_num) % ring->desc_num; 270 } 271 272 static inline int ring_space(struct hnae_ring *ring) 273 { 274 return ring->desc_num - 275 ring_dist(ring, ring->next_to_clean, ring->next_to_use) - 1; 276 } 277 278 static inline int is_ring_empty(struct hnae_ring *ring) 279 { 280 assert_is_ring_idx(ring, ring->next_to_use); 281 assert_is_ring_idx(ring, ring->next_to_clean); 282 283 return ring->next_to_use == ring->next_to_clean; 284 } 285 286 #define hnae_buf_size(_ring) ((_ring)->buf_size) 287 #define hnae_page_order(_ring) (get_order(hnae_buf_size(_ring))) 288 #define hnae_page_size(_ring) (PAGE_SIZE << hnae_page_order(_ring)) 289 290 struct hnae_handle; 291 292 /* allocate and dma map space for hnae desc */ 293 struct hnae_buf_ops { 294 int (*alloc_buffer)(struct hnae_ring *ring, struct hnae_desc_cb *cb); 295 void (*free_buffer)(struct hnae_ring *ring, struct hnae_desc_cb *cb); 296 int (*map_buffer)(struct hnae_ring *ring, struct hnae_desc_cb *cb); 297 void (*unmap_buffer)(struct hnae_ring *ring, struct hnae_desc_cb *cb); 298 }; 299 300 struct hnae_queue { 301 void __iomem *io_base; 302 phys_addr_t phy_base; 303 struct hnae_ae_dev *dev; /* the device who use this queue */ 304 struct hnae_ring rx_ring, tx_ring; 305 struct hnae_handle *handle; 306 }; 307 308 /*hnae loop mode*/ 309 enum hnae_loop { 310 MAC_INTERNALLOOP_MAC = 0, 311 MAC_INTERNALLOOP_SERDES, 312 MAC_INTERNALLOOP_PHY, 313 MAC_LOOP_NONE, 314 }; 315 316 /*hnae port type*/ 317 enum hnae_port_type { 318 HNAE_PORT_SERVICE = 0, 319 HNAE_PORT_DEBUG 320 }; 321 322 /* This struct defines the operation on the handle. 323 * 324 * get_handle(): (mandatory) 325 * Get a handle from AE according to its name and options. 326 * the AE driver should manage the space used by handle and its queues while 327 * the HNAE framework will allocate desc and desc_cb for all rings in the 328 * queues. 329 * put_handle(): 330 * Release the handle. 331 * start(): 332 * Enable the hardware, include all queues 333 * stop(): 334 * Disable the hardware 335 * set_opts(): (mandatory) 336 * Set options to the AE 337 * get_opts(): (mandatory) 338 * Get options from the AE 339 * get_status(): 340 * Get the carrier state of the back channel of the handle, 1 for ok, 0 for 341 * non-ok 342 * toggle_ring_irq(): (mandatory) 343 * Set the ring irq to be enabled(0) or disable(1) 344 * toggle_queue_status(): (mandatory) 345 * Set the queue to be enabled(1) or disable(0), this will not change the 346 * ring irq state 347 * adjust_link() 348 * adjust link status 349 * set_loopback() 350 * set loopback 351 * get_ring_bdnum_limit() 352 * get ring bd number limit 353 * get_pauseparam() 354 * get tx and rx of pause frame use 355 * set_autoneg() 356 * set auto autonegotiation of pause frame use 357 * get_autoneg() 358 * get auto autonegotiation of pause frame use 359 * set_pauseparam() 360 * set tx and rx of pause frame use 361 * get_coalesce_usecs() 362 * get usecs to delay a TX interrupt after a packet is sent 363 * get_rx_max_coalesced_frames() 364 * get Maximum number of packets to be sent before a TX interrupt. 365 * set_coalesce_usecs() 366 * set usecs to delay a TX interrupt after a packet is sent 367 * set_coalesce_frames() 368 * set Maximum number of packets to be sent before a TX interrupt. 369 * get_ringnum() 370 * get RX/TX ring number 371 * get_max_ringnum() 372 * get RX/TX ring maximum number 373 * get_mac_addr() 374 * get mac address 375 * set_mac_addr() 376 * set mac address 377 * set_mc_addr() 378 * set multicast mode 379 * set_mtu() 380 * set mtu 381 * update_stats() 382 * update Old network device statistics 383 * get_ethtool_stats() 384 * get ethtool network device statistics 385 * get_strings() 386 * get a set of strings that describe the requested objects 387 * get_sset_count() 388 * get number of strings that @get_strings will write 389 * update_led_status() 390 * update the led status 391 * set_led_id() 392 * set led id 393 * get_regs() 394 * get regs dump 395 * get_regs_len() 396 * get the len of the regs dump 397 */ 398 struct hnae_ae_ops { 399 struct hnae_handle *(*get_handle)(struct hnae_ae_dev *dev, 400 u32 port_id); 401 void (*put_handle)(struct hnae_handle *handle); 402 void (*init_queue)(struct hnae_queue *q); 403 void (*fini_queue)(struct hnae_queue *q); 404 int (*start)(struct hnae_handle *handle); 405 void (*stop)(struct hnae_handle *handle); 406 void (*reset)(struct hnae_handle *handle); 407 int (*set_opts)(struct hnae_handle *handle, int type, void *opts); 408 int (*get_opts)(struct hnae_handle *handle, int type, void **opts); 409 int (*get_status)(struct hnae_handle *handle); 410 int (*get_info)(struct hnae_handle *handle, 411 u8 *auto_neg, u16 *speed, u8 *duplex); 412 void (*toggle_ring_irq)(struct hnae_ring *ring, u32 val); 413 void (*toggle_queue_status)(struct hnae_queue *queue, u32 val); 414 void (*adjust_link)(struct hnae_handle *handle, int speed, int duplex); 415 int (*set_loopback)(struct hnae_handle *handle, 416 enum hnae_loop loop_mode, int en); 417 void (*get_ring_bdnum_limit)(struct hnae_queue *queue, 418 u32 *uplimit); 419 void (*get_pauseparam)(struct hnae_handle *handle, 420 u32 *auto_neg, u32 *rx_en, u32 *tx_en); 421 int (*set_autoneg)(struct hnae_handle *handle, u8 enable); 422 int (*get_autoneg)(struct hnae_handle *handle); 423 int (*set_pauseparam)(struct hnae_handle *handle, 424 u32 auto_neg, u32 rx_en, u32 tx_en); 425 void (*get_coalesce_usecs)(struct hnae_handle *handle, 426 u32 *tx_usecs, u32 *rx_usecs); 427 void (*get_rx_max_coalesced_frames)(struct hnae_handle *handle, 428 u32 *tx_frames, u32 *rx_frames); 429 void (*set_coalesce_usecs)(struct hnae_handle *handle, u32 timeout); 430 int (*set_coalesce_frames)(struct hnae_handle *handle, 431 u32 coalesce_frames); 432 int (*get_mac_addr)(struct hnae_handle *handle, void **p); 433 int (*set_mac_addr)(struct hnae_handle *handle, void *p); 434 int (*set_mc_addr)(struct hnae_handle *handle, void *addr); 435 int (*set_mtu)(struct hnae_handle *handle, int new_mtu); 436 void (*update_stats)(struct hnae_handle *handle, 437 struct net_device_stats *net_stats); 438 void (*get_stats)(struct hnae_handle *handle, u64 *data); 439 void (*get_strings)(struct hnae_handle *handle, 440 u32 stringset, u8 *data); 441 int (*get_sset_count)(struct hnae_handle *handle, int stringset); 442 void (*update_led_status)(struct hnae_handle *handle); 443 int (*set_led_id)(struct hnae_handle *handle, 444 enum hnae_led_state status); 445 void (*get_regs)(struct hnae_handle *handle, void *data); 446 int (*get_regs_len)(struct hnae_handle *handle); 447 }; 448 449 struct hnae_ae_dev { 450 struct device cls_dev; /* the class dev */ 451 struct device *dev; /* the presented dev */ 452 struct hnae_ae_ops *ops; 453 struct list_head node; 454 struct module *owner; /* the module who provides this dev */ 455 int id; 456 char name[AE_NAME_SIZE]; 457 struct list_head handle_list; 458 spinlock_t lock; /* lock to protect the handle_list */ 459 }; 460 461 struct hnae_handle { 462 struct device *owner_dev; /* the device which make use of this handle */ 463 struct hnae_ae_dev *dev; /* the device who provides this handle */ 464 struct device_node *phy_node; 465 phy_interface_t phy_if; 466 u32 if_support; 467 int q_num; 468 int vf_id; 469 u32 eport_id; 470 enum hnae_port_type port_type; 471 struct list_head node; /* list to hnae_ae_dev->handle_list */ 472 struct hnae_buf_ops *bops; /* operation for the buffer */ 473 struct hnae_queue **qs; /* array base of all queues */ 474 }; 475 476 #define ring_to_dev(ring) ((ring)->q->dev->dev) 477 478 struct hnae_handle *hnae_get_handle(struct device *owner_dev, const char *ae_id, 479 u32 port_id, struct hnae_buf_ops *bops); 480 void hnae_put_handle(struct hnae_handle *handle); 481 int hnae_ae_register(struct hnae_ae_dev *dev, struct module *owner); 482 void hnae_ae_unregister(struct hnae_ae_dev *dev); 483 484 int hnae_register_notifier(struct notifier_block *nb); 485 void hnae_unregister_notifier(struct notifier_block *nb); 486 int hnae_reinit_handle(struct hnae_handle *handle); 487 488 #define hnae_queue_xmit(q, buf_num) writel_relaxed(buf_num, \ 489 (q)->tx_ring.io_base + RCB_REG_TAIL) 490 491 #ifndef assert 492 #define assert(cond) 493 #endif 494 495 static inline int hnae_reserve_buffer_map(struct hnae_ring *ring, 496 struct hnae_desc_cb *cb) 497 { 498 struct hnae_buf_ops *bops = ring->q->handle->bops; 499 int ret; 500 501 ret = bops->alloc_buffer(ring, cb); 502 if (ret) 503 goto out; 504 505 ret = bops->map_buffer(ring, cb); 506 if (ret) 507 goto out_with_buf; 508 509 return 0; 510 511 out_with_buf: 512 bops->free_buffer(ring, cb); 513 out: 514 return ret; 515 } 516 517 static inline int hnae_alloc_buffer_attach(struct hnae_ring *ring, int i) 518 { 519 int ret = hnae_reserve_buffer_map(ring, &ring->desc_cb[i]); 520 521 if (ret) 522 return ret; 523 524 ring->desc[i].addr = (__le64)ring->desc_cb[i].dma; 525 526 return 0; 527 } 528 529 static inline void hnae_buffer_detach(struct hnae_ring *ring, int i) 530 { 531 ring->q->handle->bops->unmap_buffer(ring, &ring->desc_cb[i]); 532 ring->desc[i].addr = 0; 533 } 534 535 static inline void hnae_free_buffer_detach(struct hnae_ring *ring, int i) 536 { 537 struct hnae_buf_ops *bops = ring->q->handle->bops; 538 struct hnae_desc_cb *cb = &ring->desc_cb[i]; 539 540 if (!ring->desc_cb[i].dma) 541 return; 542 543 hnae_buffer_detach(ring, i); 544 bops->free_buffer(ring, cb); 545 } 546 547 /* detach a in-used buffer and replace with a reserved one */ 548 static inline void hnae_replace_buffer(struct hnae_ring *ring, int i, 549 struct hnae_desc_cb *res_cb) 550 { 551 struct hnae_buf_ops *bops = ring->q->handle->bops; 552 struct hnae_desc_cb tmp_cb = ring->desc_cb[i]; 553 554 bops->unmap_buffer(ring, &ring->desc_cb[i]); 555 ring->desc_cb[i] = *res_cb; 556 *res_cb = tmp_cb; 557 ring->desc[i].addr = (__le64)ring->desc_cb[i].dma; 558 ring->desc[i].rx.ipoff_bnum_pid_flag = 0; 559 } 560 561 static inline void hnae_reuse_buffer(struct hnae_ring *ring, int i) 562 { 563 ring->desc_cb[i].reuse_flag = 0; 564 ring->desc[i].addr = (__le64)(ring->desc_cb[i].dma 565 + ring->desc_cb[i].page_offset); 566 ring->desc[i].rx.ipoff_bnum_pid_flag = 0; 567 } 568 569 #define hnae_set_field(origin, mask, shift, val) \ 570 do { \ 571 (origin) &= (~(mask)); \ 572 (origin) |= ((val) << (shift)) & (mask); \ 573 } while (0) 574 575 #define hnae_set_bit(origin, shift, val) \ 576 hnae_set_field((origin), (0x1 << (shift)), (shift), (val)) 577 578 #define hnae_get_field(origin, mask, shift) (((origin) & (mask)) >> (shift)) 579 580 #define hnae_get_bit(origin, shift) \ 581 hnae_get_field((origin), (0x1 << (shift)), (shift)) 582 583 #endif 584