[mirror_ubuntu-bionic-kernel.git] / net / ncsi / internal.h

/*
 * Copyright Gavin Shan, IBM Corporation 2016.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 */

#ifndef __NCSI_INTERNAL_H__
#define __NCSI_INTERNAL_H__

enum {
	NCSI_CAP_BASE		= 0,
	NCSI_CAP_GENERIC	= 0,
	NCSI_CAP_BC,
	NCSI_CAP_MC,
	NCSI_CAP_BUFFER,
	NCSI_CAP_AEN,
	NCSI_CAP_VLAN,
	NCSI_CAP_MAX
};

enum {
	NCSI_CAP_GENERIC_HWA             = 0x01, /* HW arbitration           */
	NCSI_CAP_GENERIC_HDS             = 0x02, /* HNC driver status change */
	NCSI_CAP_GENERIC_FC              = 0x04, /* HNC to MC flow control   */
	NCSI_CAP_GENERIC_FC1             = 0x08, /* MC to HNC flow control   */
	NCSI_CAP_GENERIC_MC              = 0x10, /* Global MC filtering      */
	NCSI_CAP_GENERIC_HWA_UNKNOWN     = 0x00, /* Unknown HW arbitration   */
	NCSI_CAP_GENERIC_HWA_SUPPORT     = 0x20, /* Supported HW arbitration */
	NCSI_CAP_GENERIC_HWA_NOT_SUPPORT = 0x40, /* No HW arbitration        */
	NCSI_CAP_GENERIC_HWA_RESERVED    = 0x60, /* Reserved HW arbitration  */
	NCSI_CAP_GENERIC_HWA_MASK        = 0x60, /* Mask for HW arbitration  */
	NCSI_CAP_GENERIC_MASK            = 0x7f,
	NCSI_CAP_BC_ARP                  = 0x01, /* ARP packet filtering     */
	NCSI_CAP_BC_DHCPC                = 0x02, /* DHCP client filtering    */
	NCSI_CAP_BC_DHCPS                = 0x04, /* DHCP server filtering    */
	NCSI_CAP_BC_NETBIOS              = 0x08, /* NetBIOS packet filtering */
	NCSI_CAP_BC_MASK                 = 0x0f,
	NCSI_CAP_MC_IPV6_NEIGHBOR        = 0x01, /* IPv6 neighbor filtering  */
	NCSI_CAP_MC_IPV6_ROUTER          = 0x02, /* IPv6 router filering     */
	NCSI_CAP_MC_DHCPV6_RELAY         = 0x04, /* DHCPv6 relay / server MC */
	NCSI_CAP_MC_DHCPV6_WELL_KNOWN    = 0x08, /* DHCPv6 well-known MC     */
	NCSI_CAP_MC_IPV6_MLD             = 0x10, /* IPv6 MLD filtering       */
	NCSI_CAP_MC_IPV6_NEIGHBOR_S      = 0x20, /* IPv6 neighbour filtering */
	NCSI_CAP_MC_MASK                 = 0x3f,
	NCSI_CAP_AEN_LSC                 = 0x01, /* Link status change       */
	NCSI_CAP_AEN_CR                  = 0x02, /* Configuration required   */
	NCSI_CAP_AEN_HDS                 = 0x04, /* HNC driver status        */
	NCSI_CAP_AEN_MASK                = 0x07,
	NCSI_CAP_VLAN_ONLY               = 0x01, /* Filter VLAN packet only  */
	NCSI_CAP_VLAN_NO                 = 0x02, /* Filter VLAN and non-VLAN */
	NCSI_CAP_VLAN_ANY                = 0x04, /* Filter Any-and-non-VLAN  */
	NCSI_CAP_VLAN_MASK               = 0x07
};

enum {
	NCSI_MODE_BASE		= 0,
	NCSI_MODE_ENABLE	= 0,
	NCSI_MODE_TX_ENABLE,
	NCSI_MODE_LINK,
	NCSI_MODE_VLAN,
	NCSI_MODE_BC,
	NCSI_MODE_MC,
	NCSI_MODE_AEN,
	NCSI_MODE_FC,
	NCSI_MODE_MAX
};

enum {
	NCSI_FILTER_BASE	= 0,
	NCSI_FILTER_VLAN	= 0,
	NCSI_FILTER_UC,
	NCSI_FILTER_MC,
	NCSI_FILTER_MIXED,
	NCSI_FILTER_MAX
};

struct ncsi_channel_version {
	u32 version;		/* Supported BCD encoded NCSI version */
	u32 alpha2;		/* Supported BCD encoded NCSI version */
	u8  fw_name[12];	/* Firware name string                */
	u32 fw_version;		/* Firmware version                   */
	u16 pci_ids[4];		/* PCI identification                 */
	u32 mf_id;		/* Manufacture ID                     */
};

struct ncsi_channel_cap {
	u32 index;	/* Index of channel capabilities */
	u32 cap;	/* NCSI channel capability       */
};

struct ncsi_channel_mode {
	u32 index;	/* Index of channel modes      */
	u32 enable;	/* Enabled or disabled         */
	u32 size;	/* Valid entries in ncm_data[] */
	u32 data[8];	/* Data entries                */
};

struct ncsi_channel_filter {
	u32 index;	/* Index of channel filters          */
	u32 total;	/* Total entries in the filter table */
	u64 bitmap;	/* Bitmap of valid entries           */
	u32 data[];	/* Data for the valid entries        */
};

struct ncsi_channel_stats {
	u32 hnc_cnt_hi;		/* Counter cleared            */
	u32 hnc_cnt_lo;		/* Counter cleared            */
	u32 hnc_rx_bytes;	/* Rx bytes                   */
	u32 hnc_tx_bytes;	/* Tx bytes                   */
	u32 hnc_rx_uc_pkts;	/* Rx UC packets              */
	u32 hnc_rx_mc_pkts;     /* Rx MC packets              */
	u32 hnc_rx_bc_pkts;	/* Rx BC packets              */
	u32 hnc_tx_uc_pkts;	/* Tx UC packets              */
	u32 hnc_tx_mc_pkts;	/* Tx MC packets              */
	u32 hnc_tx_bc_pkts;	/* Tx BC packets              */
	u32 hnc_fcs_err;	/* FCS errors                 */
	u32 hnc_align_err;	/* Alignment errors           */
	u32 hnc_false_carrier;	/* False carrier detection    */
	u32 hnc_runt_pkts;	/* Rx runt packets            */
	u32 hnc_jabber_pkts;	/* Rx jabber packets          */
	u32 hnc_rx_pause_xon;	/* Rx pause XON frames        */
	u32 hnc_rx_pause_xoff;	/* Rx XOFF frames             */
	u32 hnc_tx_pause_xon;	/* Tx XON frames              */
	u32 hnc_tx_pause_xoff;	/* Tx XOFF frames             */
	u32 hnc_tx_s_collision;	/* Single collision frames    */
	u32 hnc_tx_m_collision;	/* Multiple collision frames  */
	u32 hnc_l_collision;	/* Late collision frames      */
	u32 hnc_e_collision;	/* Excessive collision frames */
	u32 hnc_rx_ctl_frames;	/* Rx control frames          */
	u32 hnc_rx_64_frames;	/* Rx 64-bytes frames         */
	u32 hnc_rx_127_frames;	/* Rx 65-127 bytes frames     */
	u32 hnc_rx_255_frames;	/* Rx 128-255 bytes frames    */
	u32 hnc_rx_511_frames;	/* Rx 256-511 bytes frames    */
	u32 hnc_rx_1023_frames;	/* Rx 512-1023 bytes frames   */
	u32 hnc_rx_1522_frames;	/* Rx 1024-1522 bytes frames  */
	u32 hnc_rx_9022_frames;	/* Rx 1523-9022 bytes frames  */
	u32 hnc_tx_64_frames;	/* Tx 64-bytes frames         */
	u32 hnc_tx_127_frames;	/* Tx 65-127 bytes frames     */
	u32 hnc_tx_255_frames;	/* Tx 128-255 bytes frames    */
	u32 hnc_tx_511_frames;	/* Tx 256-511 bytes frames    */
	u32 hnc_tx_1023_frames;	/* Tx 512-1023 bytes frames   */
	u32 hnc_tx_1522_frames;	/* Tx 1024-1522 bytes frames  */
	u32 hnc_tx_9022_frames;	/* Tx 1523-9022 bytes frames  */
	u32 hnc_rx_valid_bytes;	/* Rx valid bytes             */
	u32 hnc_rx_runt_pkts;	/* Rx error runt packets      */
	u32 hnc_rx_jabber_pkts;	/* Rx error jabber packets    */
	u32 ncsi_rx_cmds;	/* Rx NCSI commands           */
	u32 ncsi_dropped_cmds;	/* Dropped commands           */
	u32 ncsi_cmd_type_errs;	/* Command type errors        */
	u32 ncsi_cmd_csum_errs;	/* Command checksum errors    */
	u32 ncsi_rx_pkts;	/* Rx NCSI packets            */
	u32 ncsi_tx_pkts;	/* Tx NCSI packets            */
	u32 ncsi_tx_aen_pkts;	/* Tx AEN packets             */
	u32 pt_tx_pkts;		/* Tx packets                 */
	u32 pt_tx_dropped;	/* Tx dropped packets         */
	u32 pt_tx_channel_err;	/* Tx channel errors          */
	u32 pt_tx_us_err;	/* Tx undersize errors        */
	u32 pt_rx_pkts;		/* Rx packets                 */
	u32 pt_rx_dropped;	/* Rx dropped packets         */
	u32 pt_rx_channel_err;	/* Rx channel errors          */
	u32 pt_rx_us_err;	/* Rx undersize errors        */
	u32 pt_rx_os_err;	/* Rx oversize errors         */
};

struct ncsi_dev_priv;
struct ncsi_package;

#define NCSI_PACKAGE_SHIFT	5
#define NCSI_PACKAGE_INDEX(c)	(((c) >> NCSI_PACKAGE_SHIFT) & 0x7)
#define NCSI_RESERVED_CHANNEL	0x1f
#define NCSI_CHANNEL_INDEX(c)	((c) & ((1 << NCSI_PACKAGE_SHIFT) - 1))
#define NCSI_TO_CHANNEL(p, c)	(((p) << NCSI_PACKAGE_SHIFT) | (c))

struct ncsi_channel {
	unsigned char               id;
	int                         state;
#define NCSI_CHANNEL_INACTIVE		1
#define NCSI_CHANNEL_ACTIVE		2
#define NCSI_CHANNEL_INVISIBLE		3
	spinlock_t                  lock;	/* Protect filters etc */
	struct ncsi_package         *package;
	struct ncsi_channel_version version;
	struct ncsi_channel_cap	    caps[NCSI_CAP_MAX];
	struct ncsi_channel_mode    modes[NCSI_MODE_MAX];
	struct ncsi_channel_filter  *filters[NCSI_FILTER_MAX];
	struct ncsi_channel_stats   stats;
	struct {
		struct timer_list   timer;
		bool                enabled;
		unsigned int        state;
#define NCSI_CHANNEL_MONITOR_START	0
#define NCSI_CHANNEL_MONITOR_RETRY	1
#define NCSI_CHANNEL_MONITOR_WAIT	2
#define NCSI_CHANNEL_MONITOR_WAIT_MAX	5
	} monitor;
	struct list_head            node;
	struct list_head            link;
};

struct ncsi_package {
	unsigned char        id;          /* NCSI 3-bits package ID */
	unsigned char        uuid[16];    /* UUID                   */
	struct ncsi_dev_priv *ndp;        /* NCSI device            */
	spinlock_t           lock;        /* Protect the package    */
	unsigned int         channel_num; /* Number of channels     */
	struct list_head     channels;    /* List of chanels        */
	struct list_head     node;        /* Form list of packages  */
};

struct ncsi_request {
	unsigned char        id;      /* Request ID - 0 to 255           */
	bool                 used;    /* Request that has been assigned  */
	unsigned int         flags;   /* NCSI request property           */
#define NCSI_REQ_FLAG_EVENT_DRIVEN	1
	struct ncsi_dev_priv *ndp;    /* Associated NCSI device          */
	struct sk_buff       *cmd;    /* Associated NCSI command packet  */
	struct sk_buff       *rsp;    /* Associated NCSI response packet */
	struct timer_list    timer;   /* Timer on waiting for response   */
	bool                 enabled; /* Time has been enabled or not    */
};

enum {
	ncsi_dev_state_major		= 0xff00,
	ncsi_dev_state_minor		= 0x00ff,
	ncsi_dev_state_probe_deselect	= 0x0201,
	ncsi_dev_state_probe_package,
	ncsi_dev_state_probe_channel,
	ncsi_dev_state_probe_cis,
	ncsi_dev_state_probe_gvi,
	ncsi_dev_state_probe_gc,
	ncsi_dev_state_probe_gls,
	ncsi_dev_state_probe_dp,
	ncsi_dev_state_config_sp	= 0x0301,
	ncsi_dev_state_config_cis,
	ncsi_dev_state_config_sma,
	ncsi_dev_state_config_ebf,
#if IS_ENABLED(CONFIG_IPV6)
	ncsi_dev_state_config_egmf,
#endif
	ncsi_dev_state_config_ecnt,
	ncsi_dev_state_config_ec,
	ncsi_dev_state_config_ae,
	ncsi_dev_state_config_gls,
	ncsi_dev_state_config_done,
	ncsi_dev_state_suspend_select	= 0x0401,
	ncsi_dev_state_suspend_gls,
	ncsi_dev_state_suspend_dcnt,
	ncsi_dev_state_suspend_dc,
	ncsi_dev_state_suspend_deselect,
	ncsi_dev_state_suspend_done
};

struct ncsi_dev_priv {
	struct ncsi_dev     ndev;            /* Associated NCSI device     */
	unsigned int        flags;           /* NCSI device flags          */
#define NCSI_DEV_PROBED		1            /* Finalized NCSI topology    */
#define NCSI_DEV_HWA		2            /* Enabled HW arbitration     */
#define NCSI_DEV_RESHUFFLE	4
	spinlock_t          lock;            /* Protect the NCSI device    */
#if IS_ENABLED(CONFIG_IPV6)
	unsigned int        inet6_addr_num;  /* Number of IPv6 addresses   */
#endif
	unsigned int        package_num;     /* Number of packages         */
	struct list_head    packages;        /* List of packages           */
	struct ncsi_channel *hot_channel;    /* Channel was ever active    */
	struct ncsi_request requests[256];   /* Request table              */
	unsigned int        request_id;      /* Last used request ID       */
#define NCSI_REQ_START_IDX	1
	unsigned int        pending_req_num; /* Number of pending requests */
	struct ncsi_package *active_package; /* Currently handled package  */
	struct ncsi_channel *active_channel; /* Currently handled channel  */
	struct list_head    channel_queue;   /* Config queue of channels   */
	struct work_struct  work;            /* For channel management     */
	struct packet_type  ptype;           /* NCSI packet Rx handler     */
	struct list_head    node;            /* Form NCSI device list      */
};

struct ncsi_cmd_arg {
	struct ncsi_dev_priv *ndp;        /* Associated NCSI device        */
	unsigned char        type;        /* Command in the NCSI packet    */
	unsigned char        id;          /* Request ID (sequence number)  */
	unsigned char        package;     /* Destination package ID        */
	unsigned char        channel;     /* Detination channel ID or 0x1f */
	unsigned short       payload;     /* Command packet payload length */
	unsigned int         req_flags;   /* NCSI request properties       */
	union {
		unsigned char  bytes[16]; /* Command packet specific data  */
		unsigned short words[8];
		unsigned int   dwords[4];
	};
};

extern struct list_head ncsi_dev_list;
extern spinlock_t ncsi_dev_lock;

#define TO_NCSI_DEV_PRIV(nd) \
	container_of(nd, struct ncsi_dev_priv, ndev)
#define NCSI_FOR_EACH_DEV(ndp) \
	list_for_each_entry_rcu(ndp, &ncsi_dev_list, node)
#define NCSI_FOR_EACH_PACKAGE(ndp, np) \
	list_for_each_entry_rcu(np, &ndp->packages, node)
#define NCSI_FOR_EACH_CHANNEL(np, nc) \
	list_for_each_entry_rcu(nc, &np->channels, node)

/* Resources */
int ncsi_find_filter(struct ncsi_channel *nc, int table, void *data);
int ncsi_add_filter(struct ncsi_channel *nc, int table, void *data);
int ncsi_remove_filter(struct ncsi_channel *nc, int table, int index);
void ncsi_start_channel_monitor(struct ncsi_channel *nc);
void ncsi_stop_channel_monitor(struct ncsi_channel *nc);
struct ncsi_channel *ncsi_find_channel(struct ncsi_package *np,
				       unsigned char id);
struct ncsi_channel *ncsi_add_channel(struct ncsi_package *np,
				      unsigned char id);
struct ncsi_package *ncsi_find_package(struct ncsi_dev_priv *ndp,
				       unsigned char id);
struct ncsi_package *ncsi_add_package(struct ncsi_dev_priv *ndp,
				      unsigned char id);
void ncsi_remove_package(struct ncsi_package *np);
void ncsi_find_package_and_channel(struct ncsi_dev_priv *ndp,
				   unsigned char id,
				   struct ncsi_package **np,
				   struct ncsi_channel **nc);
struct ncsi_request *ncsi_alloc_request(struct ncsi_dev_priv *ndp,
					unsigned int req_flags);
void ncsi_free_request(struct ncsi_request *nr);
struct ncsi_dev *ncsi_find_dev(struct net_device *dev);
int ncsi_process_next_channel(struct ncsi_dev_priv *ndp);

/* Packet handlers */
u32 ncsi_calculate_checksum(unsigned char *data, int len);
int ncsi_xmit_cmd(struct ncsi_cmd_arg *nca);
int ncsi_rcv_rsp(struct sk_buff *skb, struct net_device *dev,
		 struct packet_type *pt, struct net_device *orig_dev);
int ncsi_aen_handler(struct ncsi_dev_priv *ndp, struct sk_buff *skb);

#endif /* __NCSI_INTERNAL_H__ */
Commit	Line	Data
2d283bdd GS	1	/*
	2	* Copyright Gavin Shan, IBM Corporation 2016.
	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 __NCSI_INTERNAL_H__
	11	#define __NCSI_INTERNAL_H__
	12
	13	enum {
	14	NCSI_CAP_BASE = 0,
	15	NCSI_CAP_GENERIC = 0,
	16	NCSI_CAP_BC,
	17	NCSI_CAP_MC,
	18	NCSI_CAP_BUFFER,
	19	NCSI_CAP_AEN,
	20	NCSI_CAP_VLAN,
	21	NCSI_CAP_MAX
	22	};
	23
	24	enum {
	25	NCSI_CAP_GENERIC_HWA = 0x01, /* HW arbitration */
	26	NCSI_CAP_GENERIC_HDS = 0x02, /* HNC driver status change */
	27	NCSI_CAP_GENERIC_FC = 0x04, /* HNC to MC flow control */
	28	NCSI_CAP_GENERIC_FC1 = 0x08, /* MC to HNC flow control */
	29	NCSI_CAP_GENERIC_MC = 0x10, /* Global MC filtering */
	30	NCSI_CAP_GENERIC_HWA_UNKNOWN = 0x00, /* Unknown HW arbitration */
	31	NCSI_CAP_GENERIC_HWA_SUPPORT = 0x20, /* Supported HW arbitration */
	32	NCSI_CAP_GENERIC_HWA_NOT_SUPPORT = 0x40, /* No HW arbitration */
	33	NCSI_CAP_GENERIC_HWA_RESERVED = 0x60, /* Reserved HW arbitration */
	34	NCSI_CAP_GENERIC_HWA_MASK = 0x60, /* Mask for HW arbitration */
	35	NCSI_CAP_GENERIC_MASK = 0x7f,
	36	NCSI_CAP_BC_ARP = 0x01, /* ARP packet filtering */
	37	NCSI_CAP_BC_DHCPC = 0x02, /* DHCP client filtering */
	38	NCSI_CAP_BC_DHCPS = 0x04, /* DHCP server filtering */
	39	NCSI_CAP_BC_NETBIOS = 0x08, /* NetBIOS packet filtering */
	40	NCSI_CAP_BC_MASK = 0x0f,
	41	NCSI_CAP_MC_IPV6_NEIGHBOR = 0x01, /* IPv6 neighbor filtering */
	42	NCSI_CAP_MC_IPV6_ROUTER = 0x02, /* IPv6 router filering */
	43	NCSI_CAP_MC_DHCPV6_RELAY = 0x04, /* DHCPv6 relay / server MC */
	44	NCSI_CAP_MC_DHCPV6_WELL_KNOWN = 0x08, /* DHCPv6 well-known MC */
	45	NCSI_CAP_MC_IPV6_MLD = 0x10, /* IPv6 MLD filtering */
	46	NCSI_CAP_MC_IPV6_NEIGHBOR_S = 0x20, /* IPv6 neighbour filtering */
	47	NCSI_CAP_MC_MASK = 0x3f,
	48	NCSI_CAP_AEN_LSC = 0x01, /* Link status change */
	49	NCSI_CAP_AEN_CR = 0x02, /* Configuration required */
	50	NCSI_CAP_AEN_HDS = 0x04, /* HNC driver status */
	51	NCSI_CAP_AEN_MASK = 0x07,
	52	NCSI_CAP_VLAN_ONLY = 0x01, /* Filter VLAN packet only */
	53	NCSI_CAP_VLAN_NO = 0x02, /* Filter VLAN and non-VLAN */
	54	NCSI_CAP_VLAN_ANY = 0x04, /* Filter Any-and-non-VLAN */
	55	NCSI_CAP_VLAN_MASK = 0x07
	56	};
	57
	58	enum {
	59	NCSI_MODE_BASE = 0,
	60	NCSI_MODE_ENABLE = 0,
	61	NCSI_MODE_TX_ENABLE,
	62	NCSI_MODE_LINK,
	63	NCSI_MODE_VLAN,
	64	NCSI_MODE_BC,
65	NCSI_MODE_MC,
66	NCSI_MODE_AEN,
67	NCSI_MODE_FC,
68	NCSI_MODE_MAX
69	};
70
71	enum {
72	NCSI_FILTER_BASE = 0,
73	NCSI_FILTER_VLAN = 0,
74	NCSI_FILTER_UC,
75	NCSI_FILTER_MC,
76	NCSI_FILTER_MIXED,
77	NCSI_FILTER_MAX
78	};
79
80	struct ncsi_channel_version {
81	u32 version; /* Supported BCD encoded NCSI version */
82	u32 alpha2; /* Supported BCD encoded NCSI version */
83	u8 fw_name[12]; /* Firware name string */
84	u32 fw_version; /* Firmware version */
85	u16 pci_ids[4]; /* PCI identification */
86	u32 mf_id; /* Manufacture ID */
87	};
88
89	struct ncsi_channel_cap {
90	u32 index; /* Index of channel capabilities */
91	u32 cap; /* NCSI channel capability */
92	};
93
94	struct ncsi_channel_mode {
95	u32 index; /* Index of channel modes */
96	u32 enable; /* Enabled or disabled */
97	u32 size; /* Valid entries in ncm_data[] */
98	u32 data[8]; /* Data entries */
99	};
100
101	struct ncsi_channel_filter {
102	u32 index; /* Index of channel filters */
103	u32 total; /* Total entries in the filter table */
104	u64 bitmap; /* Bitmap of valid entries */
105	u32 data[]; /* Data for the valid entries */
106	};
107
108	struct ncsi_channel_stats {
109	u32 hnc_cnt_hi; /* Counter cleared */
110	u32 hnc_cnt_lo; /* Counter cleared */
111	u32 hnc_rx_bytes; /* Rx bytes */
112	u32 hnc_tx_bytes; /* Tx bytes */
113	u32 hnc_rx_uc_pkts; /* Rx UC packets */
114	u32 hnc_rx_mc_pkts; /* Rx MC packets */
115	u32 hnc_rx_bc_pkts; /* Rx BC packets */
116	u32 hnc_tx_uc_pkts; /* Tx UC packets */
117	u32 hnc_tx_mc_pkts; /* Tx MC packets */
118	u32 hnc_tx_bc_pkts; /* Tx BC packets */
119	u32 hnc_fcs_err; /* FCS errors */
120	u32 hnc_align_err; /* Alignment errors */
121	u32 hnc_false_carrier; /* False carrier detection */
122	u32 hnc_runt_pkts; /* Rx runt packets */
123	u32 hnc_jabber_pkts; /* Rx jabber packets */
124	u32 hnc_rx_pause_xon; /* Rx pause XON frames */
125	u32 hnc_rx_pause_xoff; /* Rx XOFF frames */
126	u32 hnc_tx_pause_xon; /* Tx XON frames */
127	u32 hnc_tx_pause_xoff; /* Tx XOFF frames */
128	u32 hnc_tx_s_collision; /* Single collision frames */
129	u32 hnc_tx_m_collision; /* Multiple collision frames */
130	u32 hnc_l_collision; /* Late collision frames */
131	u32 hnc_e_collision; /* Excessive collision frames */
132	u32 hnc_rx_ctl_frames; /* Rx control frames */
133	u32 hnc_rx_64_frames; /* Rx 64-bytes frames */
134	u32 hnc_rx_127_frames; /* Rx 65-127 bytes frames */
135	u32 hnc_rx_255_frames; /* Rx 128-255 bytes frames */
136	u32 hnc_rx_511_frames; /* Rx 256-511 bytes frames */
137	u32 hnc_rx_1023_frames; /* Rx 512-1023 bytes frames */
138	u32 hnc_rx_1522_frames; /* Rx 1024-1522 bytes frames */
139	u32 hnc_rx_9022_frames; /* Rx 1523-9022 bytes frames */
140	u32 hnc_tx_64_frames; /* Tx 64-bytes frames */
141	u32 hnc_tx_127_frames; /* Tx 65-127 bytes frames */
142	u32 hnc_tx_255_frames; /* Tx 128-255 bytes frames */
143	u32 hnc_tx_511_frames; /* Tx 256-511 bytes frames */
144	u32 hnc_tx_1023_frames; /* Tx 512-1023 bytes frames */
145	u32 hnc_tx_1522_frames; /* Tx 1024-1522 bytes frames */
146	u32 hnc_tx_9022_frames; /* Tx 1523-9022 bytes frames */
147	u32 hnc_rx_valid_bytes; /* Rx valid bytes */
148	u32 hnc_rx_runt_pkts; /* Rx error runt packets */
149	u32 hnc_rx_jabber_pkts; /* Rx error jabber packets */
150	u32 ncsi_rx_cmds; /* Rx NCSI commands */
151	u32 ncsi_dropped_cmds; /* Dropped commands */
152	u32 ncsi_cmd_type_errs; /* Command type errors */
153	u32 ncsi_cmd_csum_errs; /* Command checksum errors */
154	u32 ncsi_rx_pkts; /* Rx NCSI packets */
155	u32 ncsi_tx_pkts; /* Tx NCSI packets */
156	u32 ncsi_tx_aen_pkts; /* Tx AEN packets */
157	u32 pt_tx_pkts; /* Tx packets */
158	u32 pt_tx_dropped; /* Tx dropped packets */
159	u32 pt_tx_channel_err; /* Tx channel errors */
160	u32 pt_tx_us_err; /* Tx undersize errors */
161	u32 pt_rx_pkts; /* Rx packets */
162	u32 pt_rx_dropped; /* Rx dropped packets */
163	u32 pt_rx_channel_err; /* Rx channel errors */
164	u32 pt_rx_us_err; /* Rx undersize errors */
165	u32 pt_rx_os_err; /* Rx oversize errors */
166	};
167
168	struct ncsi_dev_priv;
169	struct ncsi_package;
170
171	#define NCSI_PACKAGE_SHIFT 5
172	#define NCSI_PACKAGE_INDEX(c) (((c) >> NCSI_PACKAGE_SHIFT) & 0x7)
bc7e0f50	173	#define NCSI_RESERVED_CHANNEL 0x1f
2d283bdd GS	174	#define NCSI_CHANNEL_INDEX(c) ((c) & ((1 << NCSI_PACKAGE_SHIFT) - 1))
	175	#define NCSI_TO_CHANNEL(p, c) (((p) << NCSI_PACKAGE_SHIFT) \| (c))
	176
	177	struct ncsi_channel {
	178	unsigned char id;
	179	int state;
	180	#define NCSI_CHANNEL_INACTIVE 1
	181	#define NCSI_CHANNEL_ACTIVE 2
e6f44ed6	182	#define NCSI_CHANNEL_INVISIBLE 3
2d283bdd GS	183	spinlock_t lock; /* Protect filters etc */
	184	struct ncsi_package *package;
	185	struct ncsi_channel_version version;
	186	struct ncsi_channel_cap caps[NCSI_CAP_MAX];
	187	struct ncsi_channel_mode modes[NCSI_MODE_MAX];
	188	struct ncsi_channel_filter *filters[NCSI_FILTER_MAX];
	189	struct ncsi_channel_stats stats;
83afdc6a GS	190	struct {
	191	struct timer_list timer;
	192	bool enabled;
	193	unsigned int state;
	194	#define NCSI_CHANNEL_MONITOR_START 0
	195	#define NCSI_CHANNEL_MONITOR_RETRY 1
	196	#define NCSI_CHANNEL_MONITOR_WAIT 2
	197	#define NCSI_CHANNEL_MONITOR_WAIT_MAX 5
	198	} monitor;
2d283bdd	199	struct list_head node;
e6f44ed6	200	struct list_head link;
2d283bdd GS	201	};
	202
	203	struct ncsi_package {
	204	unsigned char id; /* NCSI 3-bits package ID */
	205	unsigned char uuid[16]; /* UUID */
	206	struct ncsi_dev_priv ndp; / NCSI device */
	207	spinlock_t lock; /* Protect the package */
	208	unsigned int channel_num; /* Number of channels */
	209	struct list_head channels; /* List of chanels */
	210	struct list_head node; /* Form list of packages */
	211	};
	212
	213	struct ncsi_request {
	214	unsigned char id; /* Request ID - 0 to 255 */
	215	bool used; /* Request that has been assigned */
a0509cbe GS	216	unsigned int flags; /* NCSI request property */
a0509cbe GS	217	#define NCSI_REQ_FLAG_EVENT_DRIVEN 1
2d283bdd GS	218	struct ncsi_dev_priv ndp; / Associated NCSI device */
	219	struct sk_buff cmd; / Associated NCSI command packet */
	220	struct sk_buff rsp; / Associated NCSI response packet */
	221	struct timer_list timer; /* Timer on waiting for response */
	222	bool enabled; /* Time has been enabled or not */
	223	};
	224
e6f44ed6 GS	225	enum {
	226	ncsi_dev_state_major = 0xff00,
	227	ncsi_dev_state_minor = 0x00ff,
	228	ncsi_dev_state_probe_deselect = 0x0201,
	229	ncsi_dev_state_probe_package,
	230	ncsi_dev_state_probe_channel,
	231	ncsi_dev_state_probe_cis,
	232	ncsi_dev_state_probe_gvi,
	233	ncsi_dev_state_probe_gc,
	234	ncsi_dev_state_probe_gls,
	235	ncsi_dev_state_probe_dp,
	236	ncsi_dev_state_config_sp = 0x0301,
	237	ncsi_dev_state_config_cis,
	238	ncsi_dev_state_config_sma,
	239	ncsi_dev_state_config_ebf,
	240	#if IS_ENABLED(CONFIG_IPV6)
	241	ncsi_dev_state_config_egmf,
	242	#endif
	243	ncsi_dev_state_config_ecnt,
	244	ncsi_dev_state_config_ec,
	245	ncsi_dev_state_config_ae,
	246	ncsi_dev_state_config_gls,
	247	ncsi_dev_state_config_done,
	248	ncsi_dev_state_suspend_select = 0x0401,
008a424a	249	ncsi_dev_state_suspend_gls,
e6f44ed6 GS	250	ncsi_dev_state_suspend_dcnt,
	251	ncsi_dev_state_suspend_dc,
	252	ncsi_dev_state_suspend_deselect,
	253	ncsi_dev_state_suspend_done
	254	};
	255
2d283bdd GS	256	struct ncsi_dev_priv {
	257	struct ncsi_dev ndev; /* Associated NCSI device */
	258	unsigned int flags; /* NCSI device flags */
e6f44ed6 GS	259	#define NCSI_DEV_PROBED 1 /* Finalized NCSI topology */
	260	#define NCSI_DEV_HWA 2 /* Enabled HW arbitration */
	261	#define NCSI_DEV_RESHUFFLE 4
2d283bdd	262	spinlock_t lock; /* Protect the NCSI device */
e6f44ed6 GS	263	#if IS_ENABLED(CONFIG_IPV6)
	264	unsigned int inet6_addr_num; /* Number of IPv6 addresses */
	265	#endif
2d283bdd GS	266	unsigned int package_num; /* Number of packages */
2d283bdd GS	267	struct list_head packages; /* List of packages */
bbc7c01e	268	struct ncsi_channel hot_channel; / Channel was ever active */
2d283bdd GS	269	struct ncsi_request requests[256]; /* Request table */
2d283bdd GS	270	unsigned int request_id; /* Last used request ID */
a15af54f	271	#define NCSI_REQ_START_IDX 1
e6f44ed6 GS	272	unsigned int pending_req_num; /* Number of pending requests */
	273	struct ncsi_package active_package; / Currently handled package */
	274	struct ncsi_channel active_channel; / Currently handled channel */
	275	struct list_head channel_queue; /* Config queue of channels */
	276	struct work_struct work; /* For channel management */
	277	struct packet_type ptype; /* NCSI packet Rx handler */
2d283bdd GS	278	struct list_head node; /* Form NCSI device list */
	279	};
	280
6389eaa7 GS	281	struct ncsi_cmd_arg {
	282	struct ncsi_dev_priv ndp; / Associated NCSI device */
	283	unsigned char type; /* Command in the NCSI packet */
	284	unsigned char id; /* Request ID (sequence number) */
	285	unsigned char package; /* Destination package ID */
	286	unsigned char channel; /* Detination channel ID or 0x1f */
	287	unsigned short payload; /* Command packet payload length */
a0509cbe	288	unsigned int req_flags; /* NCSI request properties */
6389eaa7 GS	289	union {
	290	unsigned char bytes[16]; /* Command packet specific data */
	291	unsigned short words[8];
	292	unsigned int dwords[4];
	293	};
	294	};
	295
2d283bdd GS	296	extern struct list_head ncsi_dev_list;
	297	extern spinlock_t ncsi_dev_lock;
	298
	299	#define TO_NCSI_DEV_PRIV(nd) \
	300	container_of(nd, struct ncsi_dev_priv, ndev)
	301	#define NCSI_FOR_EACH_DEV(ndp) \
	302	list_for_each_entry_rcu(ndp, &ncsi_dev_list, node)
	303	#define NCSI_FOR_EACH_PACKAGE(ndp, np) \
	304	list_for_each_entry_rcu(np, &ndp->packages, node)
	305	#define NCSI_FOR_EACH_CHANNEL(np, nc) \
	306	list_for_each_entry_rcu(nc, &np->channels, node)
	307
	308	/* Resources */
	309	int ncsi_find_filter(struct ncsi_channel nc, int table, void data);
	310	int ncsi_add_filter(struct ncsi_channel nc, int table, void data);
	311	int ncsi_remove_filter(struct ncsi_channel *nc, int table, int index);
e6f44ed6 GS	312	void ncsi_start_channel_monitor(struct ncsi_channel *nc);
e6f44ed6 GS	313	void ncsi_stop_channel_monitor(struct ncsi_channel *nc);
2d283bdd GS	314	struct ncsi_channel ncsi_find_channel(struct ncsi_package np,
	315	unsigned char id);
	316	struct ncsi_channel ncsi_add_channel(struct ncsi_package np,
	317	unsigned char id);
	318	struct ncsi_package ncsi_find_package(struct ncsi_dev_priv ndp,
	319	unsigned char id);
	320	struct ncsi_package ncsi_add_package(struct ncsi_dev_priv ndp,
	321	unsigned char id);
	322	void ncsi_remove_package(struct ncsi_package *np);
	323	void ncsi_find_package_and_channel(struct ncsi_dev_priv *ndp,
	324	unsigned char id,
	325	struct ncsi_package **np,
	326	struct ncsi_channel **nc);
a0509cbe GS	327	struct ncsi_request ncsi_alloc_request(struct ncsi_dev_priv ndp,
a0509cbe GS	328	unsigned int req_flags);
2d283bdd GS	329	void ncsi_free_request(struct ncsi_request *nr);
2d283bdd GS	330	struct ncsi_dev ncsi_find_dev(struct net_device dev);
e6f44ed6	331	int ncsi_process_next_channel(struct ncsi_dev_priv *ndp);
2d283bdd	332
6389eaa7 GS	333	/* Packet handlers */
	334	u32 ncsi_calculate_checksum(unsigned char *data, int len);
	335	int ncsi_xmit_cmd(struct ncsi_cmd_arg *nca);
138635cc GS	336	int ncsi_rcv_rsp(struct sk_buff skb, struct net_device dev,
138635cc GS	337	struct packet_type pt, struct net_device orig_dev);
7a82ecf4	338	int ncsi_aen_handler(struct ncsi_dev_priv ndp, struct sk_buff skb);
6389eaa7	339
2d283bdd	340	#endif /* __NCSI_INTERNAL_H__ */