/* SPDX-License-Identifier: BSD-2-Clause-Views */ /* * Copyright 2019-2021, The Regents of the University of California. * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * 2. Redistributions in binary form must reproduce the above * copyright notice, this list of conditions and the following * disclaimer in the documentation and/or other materials provided * with the distribution. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * * The views and conclusions contained in the software and documentation * are those of the authors and should not be interpreted as representing * official policies, either expressed or implied, of The Regents of the * University of California. */ #ifndef MQNIC_H #define MQNIC_H #include #ifdef CONFIG_PCI #include #endif #ifdef CONFIG_AUXILIARY_BUS #include #endif #include #include #include #include #include #include #include #include #include #define DRIVER_NAME "mqnic" #define DRIVER_VERSION "0.1" #include "mqnic_hw.h" #ifdef CONFIG_OF /* platform driver OF-related definitions */ #define MQNIC_PROP_MAC_ADDR_INC_BYTE "mac-address-increment-byte" #define MQNIC_PROP_MAC_ADDR_INC "mac-address-increment" #define MQNIC_PROP_MAC_ADDR_LOCAL "mac-address-local" #define MQNIC_PROP_MODULE_EEPROM "module-eeproms" #endif // default interval to poll port TX/RX status, in ms #define MQNIC_LINK_STATUS_POLL_MS 1000 extern unsigned int mqnic_num_ev_queue_entries; extern unsigned int mqnic_num_tx_queue_entries; extern unsigned int mqnic_num_rx_queue_entries; extern unsigned int mqnic_link_status_poll; struct mqnic_dev; struct mqnic_if; struct mqnic_reg_block { u32 type; u32 version; u8 __iomem *regs; u8 __iomem *base; }; struct mqnic_board_ops { int (*init)(struct mqnic_dev *mqnic); void (*deinit)(struct mqnic_dev *mqnic); }; struct mqnic_i2c_bus { struct mqnic_dev *mqnic; u8 __iomem *scl_in_reg; u8 __iomem *scl_out_reg; u8 __iomem *sda_in_reg; u8 __iomem *sda_out_reg; u32 scl_in_mask; u32 scl_out_mask; u32 sda_in_mask; u32 sda_out_mask; struct list_head head; struct i2c_algo_bit_data algo; struct i2c_adapter adapter; }; struct mqnic_irq { int index; int irqn; char name[16 + 3]; struct atomic_notifier_head nh; }; #ifdef CONFIG_AUXILIARY_BUS struct mqnic_adev { struct auxiliary_device adev; struct mqnic_dev *mdev; struct mqnic_adev **ptr; char name[32]; }; #endif struct mqnic_dev { struct device *dev; #ifdef CONFIG_PCI struct pci_dev *pdev; #endif struct platform_device *pfdev; resource_size_t hw_regs_size; phys_addr_t hw_regs_phys; u8 __iomem *hw_addr; u8 __iomem *phc_hw_addr; resource_size_t app_hw_regs_size; phys_addr_t app_hw_regs_phys; u8 __iomem *app_hw_addr; resource_size_t ram_hw_regs_size; phys_addr_t ram_hw_regs_phys; u8 __iomem *ram_hw_addr; struct mutex state_lock; int mac_count; u8 mac_list[MQNIC_MAX_IF][ETH_ALEN]; char name[16]; int irq_count; struct mqnic_irq *irq[MQNIC_MAX_IRQ]; unsigned int id; struct list_head dev_list_node; struct miscdevice misc_dev; #ifdef CONFIG_AUXILIARY_BUS struct mqnic_adev *app_adev; #endif struct mqnic_reg_block *rb_list; struct mqnic_reg_block *fw_id_rb; struct mqnic_reg_block *if_rb; struct mqnic_reg_block *stats_rb; struct mqnic_reg_block *clk_info_rb; struct mqnic_reg_block *phc_rb; int dev_port_max; int dev_port_limit; u32 fpga_id; u32 fw_id; u32 fw_ver; u32 board_id; u32 board_ver; u32 build_date; u32 git_hash; u32 rel_info; u32 app_id; u32 stats_offset; u32 stats_count; u32 stats_stride; u32 stats_flags; u32 core_clk_nom_per_ns_num; u32 core_clk_nom_per_ns_denom; u32 core_clk_nom_freq_hz; u32 ref_clk_nom_per_ns_num; u32 ref_clk_nom_per_ns_denom; u32 ref_clk_nom_freq_hz; u32 clk_info_channels; u32 if_offset; u32 if_count; u32 if_stride; u32 if_csr_offset; struct mqnic_if *interface[MQNIC_MAX_IF]; struct ptp_clock *ptp_clock; struct ptp_clock_info ptp_clock_info; struct mqnic_board_ops *board_ops; struct list_head i2c_bus; int i2c_adapter_count; int mod_i2c_client_count; struct i2c_client *mod_i2c_client[MQNIC_MAX_IF]; struct i2c_client *eeprom_i2c_client; }; struct mqnic_frag { dma_addr_t dma_addr; u32 len; }; struct mqnic_tx_info { struct sk_buff *skb; DEFINE_DMA_UNMAP_ADDR(dma_addr); DEFINE_DMA_UNMAP_LEN(len); u32 frag_count; struct mqnic_frag frags[MQNIC_MAX_FRAGS - 1]; int ts_requested; }; struct mqnic_rx_info { struct page *page; u32 page_order; u32 page_offset; dma_addr_t dma_addr; u32 len; }; struct mqnic_ring { // written on enqueue (i.e. start_xmit) u32 head_ptr; u64 bytes; u64 packets; u64 dropped_packets; struct netdev_queue *tx_queue; // written from completion u32 tail_ptr ____cacheline_aligned_in_smp; u64 ts_s; u8 ts_valid; // mostly constant u32 size; u32 full_size; u32 size_mask; u32 stride; u32 cpl_index; u32 mtu; u32 page_order; u32 desc_block_size; u32 log_desc_block_size; size_t buf_size; u8 *buf; dma_addr_t buf_dma_addr; union { struct mqnic_tx_info *tx_info; struct mqnic_rx_info *rx_info; }; struct device *dev; struct mqnic_if *interface; struct mqnic_priv *priv; int index; struct mqnic_cq_ring *cq_ring; int active; u32 hw_ptr_mask; u8 __iomem *hw_addr; u8 __iomem *hw_head_ptr; u8 __iomem *hw_tail_ptr; } ____cacheline_aligned_in_smp; struct mqnic_cq_ring { u32 head_ptr; u32 tail_ptr; u32 size; u32 size_mask; u32 stride; size_t buf_size; u8 *buf; dma_addr_t buf_dma_addr; struct device *dev; struct mqnic_if *interface; struct napi_struct napi; int index; struct mqnic_eq_ring *eq_ring; struct mqnic_ring *src_ring; int eq_index; int active; void (*handler)(struct mqnic_cq_ring *ring); u32 hw_ptr_mask; u8 __iomem *hw_addr; u8 __iomem *hw_head_ptr; u8 __iomem *hw_tail_ptr; }; struct mqnic_eq_ring { u32 head_ptr; u32 tail_ptr; u32 size; u32 size_mask; u32 stride; size_t buf_size; u8 *buf; dma_addr_t buf_dma_addr; struct device *dev; struct mqnic_if *interface; int index; struct mqnic_irq *irq; int irq_index; int active; struct notifier_block irq_nb; void (*handler)(struct mqnic_eq_ring *ring); u32 hw_ptr_mask; u8 __iomem *hw_addr; u8 __iomem *hw_head_ptr; u8 __iomem *hw_tail_ptr; }; struct mqnic_sched { struct device *dev; struct mqnic_if *interface; struct mqnic_sched_block *sched_block; struct mqnic_reg_block *rb; int index; u32 type; u32 offset; u32 channel_count; u32 channel_stride; u8 __iomem *hw_addr; }; struct mqnic_port { struct device *dev; struct mqnic_if *interface; struct mqnic_reg_block *port_rb; struct mqnic_reg_block *rb_list; struct mqnic_reg_block *port_ctrl_rb; int index; u32 port_features; }; struct mqnic_sched_block { struct device *dev; struct mqnic_if *interface; struct mqnic_reg_block *block_rb; struct mqnic_reg_block *rb_list; int index; u32 tx_queue_count; u32 sched_count; struct mqnic_sched *sched[MQNIC_MAX_PORTS]; }; struct mqnic_if { struct device *dev; struct mqnic_dev *mdev; struct mqnic_reg_block *rb_list; struct mqnic_reg_block *if_ctrl_rb; struct mqnic_reg_block *event_queue_rb; struct mqnic_reg_block *tx_queue_rb; struct mqnic_reg_block *tx_cpl_queue_rb; struct mqnic_reg_block *rx_queue_rb; struct mqnic_reg_block *rx_cpl_queue_rb; struct mqnic_reg_block *rx_queue_map_rb; int index; int dev_port_base; int dev_port_max; int dev_port_limit; u32 if_features; u32 max_tx_mtu; u32 max_rx_mtu; u32 event_queue_offset; u32 event_queue_count; u32 event_queue_stride; struct mqnic_eq_ring *event_ring[MQNIC_MAX_EVENT_RINGS]; u32 tx_queue_offset; u32 tx_queue_count; u32 tx_queue_stride; struct mqnic_ring *tx_ring[MQNIC_MAX_TX_RINGS]; u32 tx_cpl_queue_offset; u32 tx_cpl_queue_count; u32 tx_cpl_queue_stride; struct mqnic_cq_ring *tx_cpl_ring[MQNIC_MAX_TX_CPL_RINGS]; u32 rx_queue_offset; u32 rx_queue_count; u32 rx_queue_stride; struct mqnic_ring *rx_ring[MQNIC_MAX_RX_RINGS]; u32 rx_cpl_queue_offset; u32 rx_cpl_queue_count; u32 rx_cpl_queue_stride; struct mqnic_cq_ring *rx_cpl_ring[MQNIC_MAX_RX_CPL_RINGS]; u32 port_count; struct mqnic_port *port[MQNIC_MAX_PORTS]; u32 sched_block_count; struct mqnic_sched_block *sched_block[MQNIC_MAX_PORTS]; u32 max_desc_block_size; u32 rx_queue_map_indir_table_size; u8 __iomem *rx_queue_map_indir_table[MQNIC_MAX_PORTS]; resource_size_t hw_regs_size; u8 __iomem *hw_addr; u8 __iomem *csr_hw_addr; u32 ndev_count; struct net_device *ndev[MQNIC_MAX_PORTS]; struct i2c_client *mod_i2c_client; }; struct mqnic_priv { struct device *dev; struct net_device *ndev; struct mqnic_dev *mdev; struct mqnic_if *interface; spinlock_t stats_lock; int index; bool registered; bool port_up; u32 if_features; unsigned int link_status; struct timer_list link_status_timer; u32 event_queue_count; struct mqnic_eq_ring *event_ring[MQNIC_MAX_EVENT_RINGS]; u32 tx_queue_count; struct mqnic_ring *tx_ring[MQNIC_MAX_TX_RINGS]; u32 tx_cpl_queue_count; struct mqnic_cq_ring *tx_cpl_ring[MQNIC_MAX_TX_CPL_RINGS]; u32 rx_queue_count; struct mqnic_ring *rx_ring[MQNIC_MAX_RX_RINGS]; u32 rx_cpl_queue_count; struct mqnic_cq_ring *rx_cpl_ring[MQNIC_MAX_RX_CPL_RINGS]; u32 sched_block_count; struct mqnic_sched_block *sched_block[MQNIC_MAX_PORTS]; u32 max_desc_block_size; struct hwtstamp_config hwts_config; struct i2c_client *mod_i2c_client; }; // mqnic_main.c // mqnic_reg_block.c struct mqnic_reg_block *mqnic_enumerate_reg_block_list(u8 __iomem *base, size_t offset, size_t size); struct mqnic_reg_block *mqnic_find_reg_block(struct mqnic_reg_block *list, u32 type, u32 version, int index); void mqnic_free_reg_block_list(struct mqnic_reg_block *list); // mqnic_irq.c int mqnic_irq_init_pcie(struct mqnic_dev *mdev); void mqnic_irq_deinit_pcie(struct mqnic_dev *mdev); int mqnic_irq_init_platform(struct mqnic_dev *mdev); // mqnic_dev.c extern const struct file_operations mqnic_fops; // mqnic_if.c int mqnic_create_interface(struct mqnic_dev *mdev, struct mqnic_if **interface_ptr, int index, u8 __iomem *hw_addr); void mqnic_destroy_interface(struct mqnic_if **interface_ptr); u32 mqnic_interface_get_tx_mtu(struct mqnic_if *interface); void mqnic_interface_set_tx_mtu(struct mqnic_if *interface, u32 mtu); u32 mqnic_interface_get_rx_mtu(struct mqnic_if *interface); void mqnic_interface_set_rx_mtu(struct mqnic_if *interface, u32 mtu); u32 mqnic_interface_get_rx_queue_map_rss_mask(struct mqnic_if *interface, int port); void mqnic_interface_set_rx_queue_map_rss_mask(struct mqnic_if *interface, int port, u32 val); u32 mqnic_interface_get_rx_queue_map_app_mask(struct mqnic_if *interface, int port); void mqnic_interface_set_rx_queue_map_app_mask(struct mqnic_if *interface, int port, u32 val); u32 mqnic_interface_get_rx_queue_map_indir_table(struct mqnic_if *interface, int port, int index); void mqnic_interface_set_rx_queue_map_indir_table(struct mqnic_if *interface, int port, int index, u32 val); // mqnic_port.c int mqnic_create_port(struct mqnic_if *interface, struct mqnic_port **port_ptr, int index, struct mqnic_reg_block *port_rb); void mqnic_destroy_port(struct mqnic_port **port_ptr); u32 mqnic_port_get_tx_status(struct mqnic_port *port); u32 mqnic_port_get_rx_status(struct mqnic_port *port); // mqnic_netdev.c void mqnic_update_stats(struct net_device *ndev); int mqnic_create_netdev(struct mqnic_if *interface, struct net_device **ndev_ptr, int index, int dev_port); void mqnic_destroy_netdev(struct net_device **ndev_ptr); // mqnic_sched_block.c int mqnic_create_sched_block(struct mqnic_if *interface, struct mqnic_sched_block **block_ptr, int index, struct mqnic_reg_block *rb); void mqnic_destroy_sched_block(struct mqnic_sched_block **block_ptr); int mqnic_activate_sched_block(struct mqnic_sched_block *block); void mqnic_deactivate_sched_block(struct mqnic_sched_block *block); // mqnic_scheduler.c int mqnic_create_scheduler(struct mqnic_sched_block *block, struct mqnic_sched **sched_ptr, int index, struct mqnic_reg_block *rb); void mqnic_destroy_scheduler(struct mqnic_sched **sched_ptr); int mqnic_scheduler_enable(struct mqnic_sched *sched); void mqnic_scheduler_disable(struct mqnic_sched *sched); // mqnic_ptp.c void mqnic_register_phc(struct mqnic_dev *mdev); void mqnic_unregister_phc(struct mqnic_dev *mdev); ktime_t mqnic_read_cpl_ts(struct mqnic_dev *mdev, struct mqnic_ring *ring, const struct mqnic_cpl *cpl); // mqnic_i2c.c struct mqnic_i2c_bus *mqnic_i2c_bus_create(struct mqnic_dev *mqnic, int index); struct i2c_adapter *mqnic_i2c_adapter_create(struct mqnic_dev *mqnic, int index); void mqnic_i2c_bus_release(struct mqnic_i2c_bus *bus); void mqnic_i2c_adapter_release(struct i2c_adapter *adapter); int mqnic_i2c_init(struct mqnic_dev *mqnic); void mqnic_i2c_deinit(struct mqnic_dev *mqnic); // mqnic_board.c int mqnic_board_init(struct mqnic_dev *mqnic); void mqnic_board_deinit(struct mqnic_dev *mqnic); // mqnic_clk_info.c void mqnic_clk_info_init(struct mqnic_dev *mdev); u32 mqnic_get_core_clk_nom_freq_hz(struct mqnic_dev *mdev); u32 mqnic_get_ref_clk_nom_freq_hz(struct mqnic_dev *mdev); u32 mqnic_get_core_clk_freq_hz(struct mqnic_dev *mdev); u32 mqnic_get_clk_freq_hz(struct mqnic_dev *mdev, int ch); u64 mqnic_core_clk_cycles_to_ns(struct mqnic_dev *mdev, u64 cycles); u64 mqnic_core_clk_ns_to_cycles(struct mqnic_dev *mdev, u64 ns); u64 mqnic_ref_clk_cycles_to_ns(struct mqnic_dev *mdev, u64 cycles); u64 mqnic_ref_clk_ns_to_cycles(struct mqnic_dev *mdev, u64 ns); // mqnic_stats.c void mqnic_stats_init(struct mqnic_dev *mdev); u64 mqnic_stats_read(struct mqnic_dev *mdev, int index); // mqnic_eq.c int mqnic_create_eq_ring(struct mqnic_if *interface, struct mqnic_eq_ring **ring_ptr, int index, u8 __iomem *hw_addr); void mqnic_destroy_eq_ring(struct mqnic_eq_ring **ring_ptr); int mqnic_alloc_eq_ring(struct mqnic_eq_ring *ring, int size, int stride); void mqnic_free_eq_ring(struct mqnic_eq_ring *ring); int mqnic_activate_eq_ring(struct mqnic_eq_ring *ring, struct mqnic_irq *irq); void mqnic_deactivate_eq_ring(struct mqnic_eq_ring *ring); void mqnic_eq_read_head_ptr(struct mqnic_eq_ring *ring); void mqnic_eq_write_tail_ptr(struct mqnic_eq_ring *ring); void mqnic_arm_eq(struct mqnic_eq_ring *ring); void mqnic_process_eq(struct mqnic_eq_ring *eq_ring); // mqnic_cq.c int mqnic_create_cq_ring(struct mqnic_if *interface, struct mqnic_cq_ring **ring_ptr, int index, u8 __iomem *hw_addr); void mqnic_destroy_cq_ring(struct mqnic_cq_ring **ring_ptr); int mqnic_alloc_cq_ring(struct mqnic_cq_ring *ring, int size, int stride); void mqnic_free_cq_ring(struct mqnic_cq_ring *ring); int mqnic_activate_cq_ring(struct mqnic_cq_ring *ring, struct mqnic_eq_ring *eq_ring); void mqnic_deactivate_cq_ring(struct mqnic_cq_ring *ring); void mqnic_cq_read_head_ptr(struct mqnic_cq_ring *ring); void mqnic_cq_write_tail_ptr(struct mqnic_cq_ring *ring); void mqnic_arm_cq(struct mqnic_cq_ring *ring); // mqnic_tx.c int mqnic_create_tx_ring(struct mqnic_if *interface, struct mqnic_ring **ring_ptr, int index, u8 __iomem *hw_addr); void mqnic_destroy_tx_ring(struct mqnic_ring **ring_ptr); int mqnic_alloc_tx_ring(struct mqnic_ring *ring, int size, int stride); void mqnic_free_tx_ring(struct mqnic_ring *ring); int mqnic_activate_tx_ring(struct mqnic_ring *ring, struct mqnic_priv *priv, struct mqnic_cq_ring *cq_ring); void mqnic_deactivate_tx_ring(struct mqnic_ring *ring); bool mqnic_is_tx_ring_empty(const struct mqnic_ring *ring); bool mqnic_is_tx_ring_full(const struct mqnic_ring *ring); void mqnic_tx_read_tail_ptr(struct mqnic_ring *ring); void mqnic_tx_write_head_ptr(struct mqnic_ring *ring); void mqnic_free_tx_desc(struct mqnic_ring *ring, int index, int napi_budget); int mqnic_free_tx_buf(struct mqnic_ring *ring); int mqnic_process_tx_cq(struct mqnic_cq_ring *cq_ring, int napi_budget); void mqnic_tx_irq(struct mqnic_cq_ring *cq); int mqnic_poll_tx_cq(struct napi_struct *napi, int budget); netdev_tx_t mqnic_start_xmit(struct sk_buff *skb, struct net_device *dev); // mqnic_rx.c int mqnic_create_rx_ring(struct mqnic_if *interface, struct mqnic_ring **ring_ptr, int index, u8 __iomem *hw_addr); void mqnic_destroy_rx_ring(struct mqnic_ring **ring_ptr); int mqnic_alloc_rx_ring(struct mqnic_ring *ring, int size, int stride); void mqnic_free_rx_ring(struct mqnic_ring *ring); int mqnic_activate_rx_ring(struct mqnic_ring *ring, struct mqnic_priv *priv, struct mqnic_cq_ring *cq_ring); void mqnic_deactivate_rx_ring(struct mqnic_ring *ring); bool mqnic_is_rx_ring_empty(const struct mqnic_ring *ring); bool mqnic_is_rx_ring_full(const struct mqnic_ring *ring); void mqnic_rx_read_tail_ptr(struct mqnic_ring *ring); void mqnic_rx_write_head_ptr(struct mqnic_ring *ring); void mqnic_free_rx_desc(struct mqnic_ring *ring, int index); int mqnic_free_rx_buf(struct mqnic_ring *ring); int mqnic_prepare_rx_desc(struct mqnic_ring *ring, int index); void mqnic_refill_rx_buffers(struct mqnic_ring *ring); int mqnic_process_rx_cq(struct mqnic_cq_ring *cq_ring, int napi_budget); void mqnic_rx_irq(struct mqnic_cq_ring *cq); int mqnic_poll_rx_cq(struct napi_struct *napi, int budget); // mqnic_ethtool.c extern const struct ethtool_ops mqnic_ethtool_ops; #endif /* MQNIC_H */