[mirror_ubuntu-eoan-kernel.git] / drivers / net / ethernet / aquantia / atlantic / aq_hw.h

/*
 * aQuantia Corporation Network Driver
 * Copyright (C) 2014-2017 aQuantia Corporation. All rights reserved
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms and conditions of the GNU General Public License,
 * version 2, as published by the Free Software Foundation.
 */

/* File aq_hw.h: Declaraion of abstract interface for NIC hardware specific
 * functions.
 */

#ifndef AQ_HW_H
#define AQ_HW_H

#include "aq_common.h"

/* NIC H/W capabilities */
struct aq_hw_caps_s {
	u64 hw_features;
	u64 link_speed_msk;
	unsigned int hw_priv_flags;
	u32 rxds;
	u32 txds;
	u32 txhwb_alignment;
	u32 irq_mask;
	u32 vecs;
	u32 mtu;
	u32 mac_regs_count;
	u8 ports;
	u8 msix_irqs;
	u8 tcs;
	u8 rxd_alignment;
	u8 rxd_size;
	u8 txd_alignment;
	u8 txd_size;
	u8 tx_rings;
	u8 rx_rings;
	bool flow_control;
	bool is_64_dma;
	u32 fw_ver_expected;
};

struct aq_hw_link_status_s {
	unsigned int mbps;
};

#define AQ_HW_IRQ_INVALID 0U
#define AQ_HW_IRQ_LEGACY  1U
#define AQ_HW_IRQ_MSI     2U
#define AQ_HW_IRQ_MSIX    3U

#define AQ_HW_POWER_STATE_D0   0U
#define AQ_HW_POWER_STATE_D3   3U

#define AQ_HW_FLAG_STARTED     0x00000004U
#define AQ_HW_FLAG_STOPPING    0x00000008U
#define AQ_HW_FLAG_RESETTING   0x00000010U
#define AQ_HW_FLAG_CLOSING     0x00000020U
#define AQ_HW_LINK_DOWN        0x04000000U
#define AQ_HW_FLAG_ERR_UNPLUG  0x40000000U
#define AQ_HW_FLAG_ERR_HW      0x80000000U

#define AQ_HW_FLAG_ERRORS      (AQ_HW_FLAG_ERR_HW | AQ_HW_FLAG_ERR_UNPLUG)

struct aq_hw_s {
	struct aq_obj_s header;
	struct aq_nic_cfg_s *aq_nic_cfg;
	struct aq_pci_func_s *aq_pci_func;
	void __iomem *mmio;
	unsigned int not_ff_addr;
	struct aq_hw_link_status_s aq_link_status;
};

struct aq_ring_s;
struct aq_ring_param_s;
struct aq_nic_cfg_s;
struct sk_buff;

struct aq_hw_ops {
	struct aq_hw_s *(*create)(struct aq_pci_func_s *aq_pci_func,
				  unsigned int port, struct aq_hw_ops *ops);

	void (*destroy)(struct aq_hw_s *self);

	int (*get_hw_caps)(struct aq_hw_s *self,
			   struct aq_hw_caps_s *aq_hw_caps);

	int (*hw_ring_tx_xmit)(struct aq_hw_s *self, struct aq_ring_s *aq_ring,
			       unsigned int frags);

	int (*hw_ring_rx_receive)(struct aq_hw_s *self,
				  struct aq_ring_s *aq_ring);

	int (*hw_ring_rx_fill)(struct aq_hw_s *self, struct aq_ring_s *aq_ring,
			       unsigned int sw_tail_old);

	int (*hw_ring_tx_head_update)(struct aq_hw_s *self,
				      struct aq_ring_s *aq_ring);

	int (*hw_get_mac_permanent)(struct aq_hw_s *self,
				    struct aq_hw_caps_s *aq_hw_caps,
				    u8 *mac);

	int (*hw_set_mac_address)(struct aq_hw_s *self, u8 *mac_addr);

	int (*hw_get_link_status)(struct aq_hw_s *self,
				  struct aq_hw_link_status_s *link_status);

	int (*hw_set_link_speed)(struct aq_hw_s *self, u32 speed);

	int (*hw_reset)(struct aq_hw_s *self);

	int (*hw_init)(struct aq_hw_s *self, struct aq_nic_cfg_s *aq_nic_cfg,
		       u8 *mac_addr);

	int (*hw_start)(struct aq_hw_s *self);

	int (*hw_stop)(struct aq_hw_s *self);

	int (*hw_ring_tx_init)(struct aq_hw_s *self, struct aq_ring_s *aq_ring,
			       struct aq_ring_param_s *aq_ring_param);

	int (*hw_ring_tx_start)(struct aq_hw_s *self,
				struct aq_ring_s *aq_ring);

	int (*hw_ring_tx_stop)(struct aq_hw_s *self,
			       struct aq_ring_s *aq_ring);

	int (*hw_ring_rx_init)(struct aq_hw_s *self,
			       struct aq_ring_s *aq_ring,
			       struct aq_ring_param_s *aq_ring_param);

	int (*hw_ring_rx_start)(struct aq_hw_s *self,
				struct aq_ring_s *aq_ring);

	int (*hw_ring_rx_stop)(struct aq_hw_s *self,
			       struct aq_ring_s *aq_ring);

	int (*hw_irq_enable)(struct aq_hw_s *self, u64 mask);

	int (*hw_irq_disable)(struct aq_hw_s *self, u64 mask);

	int (*hw_irq_read)(struct aq_hw_s *self, u64 *mask);

	int (*hw_packet_filter_set)(struct aq_hw_s *self,
				    unsigned int packet_filter);

	int (*hw_multicast_list_set)(struct aq_hw_s *self,
				     u8 ar_mac[AQ_CFG_MULTICAST_ADDRESS_MAX]
				     [ETH_ALEN],
				     u32 count);

	int (*hw_interrupt_moderation_set)(struct aq_hw_s *self,
					   bool itr_enabled);

	int (*hw_rss_set)(struct aq_hw_s *self,
			  struct aq_rss_parameters *rss_params);

	int (*hw_rss_hash_set)(struct aq_hw_s *self,
			       struct aq_rss_parameters *rss_params);

	int (*hw_get_regs)(struct aq_hw_s *self,
			   struct aq_hw_caps_s *aq_hw_caps, u32 *regs_buff);

	int (*hw_get_hw_stats)(struct aq_hw_s *self, u64 *data,
			       unsigned int *p_count);

	int (*hw_get_fw_version)(struct aq_hw_s *self, u32 *fw_version);

	int (*hw_deinit)(struct aq_hw_s *self);

	int (*hw_set_power)(struct aq_hw_s *self, unsigned int power_state);
};

#endif /* AQ_HW_H */
Commit	Line	Data
753f4783 DV	1	/*
	2	* aQuantia Corporation Network Driver
	3	* Copyright (C) 2014-2017 aQuantia Corporation. All rights reserved
	4	*
	5	* This program is free software; you can redistribute it and/or modify it
	6	* under the terms and conditions of the GNU General Public License,
	7	* version 2, as published by the Free Software Foundation.
	8	*/
	9
	10	/* File aq_hw.h: Declaraion of abstract interface for NIC hardware specific
	11	* functions.
	12	*/
	13
	14	#ifndef AQ_HW_H
	15	#define AQ_HW_H
	16
	17	#include "aq_common.h"
	18
	19	/* NIC H/W capabilities */
	20	struct aq_hw_caps_s {
	21	u64 hw_features;
	22	u64 link_speed_msk;
	23	unsigned int hw_priv_flags;
	24	u32 rxds;
	25	u32 txds;
	26	u32 txhwb_alignment;
	27	u32 irq_mask;
	28	u32 vecs;
	29	u32 mtu;
	30	u32 mac_regs_count;
	31	u8 ports;
	32	u8 msix_irqs;
	33	u8 tcs;
	34	u8 rxd_alignment;
	35	u8 rxd_size;
	36	u8 txd_alignment;
	37	u8 txd_size;
	38	u8 tx_rings;
	39	u8 rx_rings;
	40	bool flow_control;
	41	bool is_64_dma;
	42	u32 fw_ver_expected;
	43	};
	44
	45	struct aq_hw_link_status_s {
	46	unsigned int mbps;
	47	};
	48
	49	#define AQ_HW_IRQ_INVALID 0U
	50	#define AQ_HW_IRQ_LEGACY 1U
	51	#define AQ_HW_IRQ_MSI 2U
	52	#define AQ_HW_IRQ_MSIX 3U
	53
	54	#define AQ_HW_POWER_STATE_D0 0U
	55	#define AQ_HW_POWER_STATE_D3 3U
	56
	57	#define AQ_HW_FLAG_STARTED 0x00000004U
	58	#define AQ_HW_FLAG_STOPPING 0x00000008U
	59	#define AQ_HW_FLAG_RESETTING 0x00000010U
	60	#define AQ_HW_FLAG_CLOSING 0x00000020U
	61	#define AQ_HW_LINK_DOWN 0x04000000U
	62	#define AQ_HW_FLAG_ERR_UNPLUG 0x40000000U
	63	#define AQ_HW_FLAG_ERR_HW 0x80000000U
	64
65	#define AQ_HW_FLAG_ERRORS (AQ_HW_FLAG_ERR_HW \| AQ_HW_FLAG_ERR_UNPLUG)
66
67	struct aq_hw_s {
68	struct aq_obj_s header;
69	struct aq_nic_cfg_s *aq_nic_cfg;
70	struct aq_pci_func_s *aq_pci_func;
71	void __iomem *mmio;
72	unsigned int not_ff_addr;
73	struct aq_hw_link_status_s aq_link_status;
74	};
75
76	struct aq_ring_s;
77	struct aq_ring_param_s;
78	struct aq_nic_cfg_s;
79	struct sk_buff;
80
81	struct aq_hw_ops {
82	struct aq_hw_s (create)(struct aq_pci_func_s *aq_pci_func,
83	unsigned int port, struct aq_hw_ops *ops);
84
85	void (destroy)(struct aq_hw_s self);
86
87	int (get_hw_caps)(struct aq_hw_s self,
88	struct aq_hw_caps_s *aq_hw_caps);
89
90	int (hw_ring_tx_xmit)(struct aq_hw_s self, struct aq_ring_s *aq_ring,
91	unsigned int frags);
92
93	int (hw_ring_rx_receive)(struct aq_hw_s self,
94	struct aq_ring_s *aq_ring);
95
96	int (hw_ring_rx_fill)(struct aq_hw_s self, struct aq_ring_s *aq_ring,
97	unsigned int sw_tail_old);
98
99	int (hw_ring_tx_head_update)(struct aq_hw_s self,
100	struct aq_ring_s *aq_ring);
101
102	int (hw_get_mac_permanent)(struct aq_hw_s self,
103	struct aq_hw_caps_s *aq_hw_caps,
104	u8 *mac);
105
106	int (hw_set_mac_address)(struct aq_hw_s self, u8 *mac_addr);
107
108	int (hw_get_link_status)(struct aq_hw_s self,
109	struct aq_hw_link_status_s *link_status);
110
111	int (hw_set_link_speed)(struct aq_hw_s self, u32 speed);
112
113	int (hw_reset)(struct aq_hw_s self);
114
115	int (hw_init)(struct aq_hw_s self, struct aq_nic_cfg_s *aq_nic_cfg,
116	u8 *mac_addr);
117
118	int (hw_start)(struct aq_hw_s self);
119
120	int (hw_stop)(struct aq_hw_s self);
121
122	int (hw_ring_tx_init)(struct aq_hw_s self, struct aq_ring_s *aq_ring,
123	struct aq_ring_param_s *aq_ring_param);
124
125	int (hw_ring_tx_start)(struct aq_hw_s self,
126	struct aq_ring_s *aq_ring);
127
128	int (hw_ring_tx_stop)(struct aq_hw_s self,
129	struct aq_ring_s *aq_ring);
130
131	int (hw_ring_rx_init)(struct aq_hw_s self,
132	struct aq_ring_s *aq_ring,
133	struct aq_ring_param_s *aq_ring_param);
134
135	int (hw_ring_rx_start)(struct aq_hw_s self,
136	struct aq_ring_s *aq_ring);
137
138	int (hw_ring_rx_stop)(struct aq_hw_s self,
139	struct aq_ring_s *aq_ring);
140
141	int (hw_irq_enable)(struct aq_hw_s self, u64 mask);
142
143	int (hw_irq_disable)(struct aq_hw_s self, u64 mask);
144
145	int (hw_irq_read)(struct aq_hw_s self, u64 *mask);
146
147	int (hw_packet_filter_set)(struct aq_hw_s self,
148	unsigned int packet_filter);
149
150	int (hw_multicast_list_set)(struct aq_hw_s self,
151	u8 ar_mac[AQ_CFG_MULTICAST_ADDRESS_MAX]
152	[ETH_ALEN],
153	u32 count);
154
155	int (hw_interrupt_moderation_set)(struct aq_hw_s self,
156	bool itr_enabled);
157
158	int (hw_rss_set)(struct aq_hw_s self,
159	struct aq_rss_parameters *rss_params);
160
161	int (hw_rss_hash_set)(struct aq_hw_s self,
162	struct aq_rss_parameters *rss_params);
163
164	int (hw_get_regs)(struct aq_hw_s self,
165	struct aq_hw_caps_s aq_hw_caps, u32 regs_buff);
166
167	int (hw_get_hw_stats)(struct aq_hw_s self, u64 *data,
168	unsigned int *p_count);
169
170	int (hw_get_fw_version)(struct aq_hw_s self, u32 *fw_version);
171
172	int (hw_deinit)(struct aq_hw_s self);
173
174	int (hw_set_power)(struct aq_hw_s self, unsigned int power_state);
175	};
176
177	#endif /* AQ_HW_H */