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 /* OEM Vendor Manufacture ID */ 72 #define NCSI_OEM_MFR_MLX_ID 0x8119 73 #define NCSI_OEM_MFR_BCM_ID 0x113d 74 /* Broadcom specific OEM Command */ 75 #define NCSI_OEM_BCM_CMD_GMA 0x01 /* CMD ID for Get MAC */ 76 /* OEM Command payload lengths*/ 77 #define NCSI_OEM_BCM_CMD_GMA_LEN 12 78 /* Mac address offset in OEM response */ 79 #define BCM_MAC_ADDR_OFFSET 28 80 81 82 struct ncsi_channel_version { 83 u32 version; /* Supported BCD encoded NCSI version */ 84 u32 alpha2; /* Supported BCD encoded NCSI version */ 85 u8 fw_name[12]; /* Firware name string */ 86 u32 fw_version; /* Firmware version */ 87 u16 pci_ids[4]; /* PCI identification */ 88 u32 mf_id; /* Manufacture ID */ 89 }; 90 91 struct ncsi_channel_cap { 92 u32 index; /* Index of channel capabilities */ 93 u32 cap; /* NCSI channel capability */ 94 }; 95 96 struct ncsi_channel_mode { 97 u32 index; /* Index of channel modes */ 98 u32 enable; /* Enabled or disabled */ 99 u32 size; /* Valid entries in ncm_data[] */ 100 u32 data[8]; /* Data entries */ 101 }; 102 103 struct ncsi_channel_mac_filter { 104 u8 n_uc; 105 u8 n_mc; 106 u8 n_mixed; 107 u64 bitmap; 108 unsigned char *addrs; 109 }; 110 111 struct ncsi_channel_vlan_filter { 112 u8 n_vids; 113 u64 bitmap; 114 u16 *vids; 115 }; 116 117 struct ncsi_channel_stats { 118 u32 hnc_cnt_hi; /* Counter cleared */ 119 u32 hnc_cnt_lo; /* Counter cleared */ 120 u32 hnc_rx_bytes; /* Rx bytes */ 121 u32 hnc_tx_bytes; /* Tx bytes */ 122 u32 hnc_rx_uc_pkts; /* Rx UC packets */ 123 u32 hnc_rx_mc_pkts; /* Rx MC packets */ 124 u32 hnc_rx_bc_pkts; /* Rx BC packets */ 125 u32 hnc_tx_uc_pkts; /* Tx UC packets */ 126 u32 hnc_tx_mc_pkts; /* Tx MC packets */ 127 u32 hnc_tx_bc_pkts; /* Tx BC packets */ 128 u32 hnc_fcs_err; /* FCS errors */ 129 u32 hnc_align_err; /* Alignment errors */ 130 u32 hnc_false_carrier; /* False carrier detection */ 131 u32 hnc_runt_pkts; /* Rx runt packets */ 132 u32 hnc_jabber_pkts; /* Rx jabber packets */ 133 u32 hnc_rx_pause_xon; /* Rx pause XON frames */ 134 u32 hnc_rx_pause_xoff; /* Rx XOFF frames */ 135 u32 hnc_tx_pause_xon; /* Tx XON frames */ 136 u32 hnc_tx_pause_xoff; /* Tx XOFF frames */ 137 u32 hnc_tx_s_collision; /* Single collision frames */ 138 u32 hnc_tx_m_collision; /* Multiple collision frames */ 139 u32 hnc_l_collision; /* Late collision frames */ 140 u32 hnc_e_collision; /* Excessive collision frames */ 141 u32 hnc_rx_ctl_frames; /* Rx control frames */ 142 u32 hnc_rx_64_frames; /* Rx 64-bytes frames */ 143 u32 hnc_rx_127_frames; /* Rx 65-127 bytes frames */ 144 u32 hnc_rx_255_frames; /* Rx 128-255 bytes frames */ 145 u32 hnc_rx_511_frames; /* Rx 256-511 bytes frames */ 146 u32 hnc_rx_1023_frames; /* Rx 512-1023 bytes frames */ 147 u32 hnc_rx_1522_frames; /* Rx 1024-1522 bytes frames */ 148 u32 hnc_rx_9022_frames; /* Rx 1523-9022 bytes frames */ 149 u32 hnc_tx_64_frames; /* Tx 64-bytes frames */ 150 u32 hnc_tx_127_frames; /* Tx 65-127 bytes frames */ 151 u32 hnc_tx_255_frames; /* Tx 128-255 bytes frames */ 152 u32 hnc_tx_511_frames; /* Tx 256-511 bytes frames */ 153 u32 hnc_tx_1023_frames; /* Tx 512-1023 bytes frames */ 154 u32 hnc_tx_1522_frames; /* Tx 1024-1522 bytes frames */ 155 u32 hnc_tx_9022_frames; /* Tx 1523-9022 bytes frames */ 156 u32 hnc_rx_valid_bytes; /* Rx valid bytes */ 157 u32 hnc_rx_runt_pkts; /* Rx error runt packets */ 158 u32 hnc_rx_jabber_pkts; /* Rx error jabber packets */ 159 u32 ncsi_rx_cmds; /* Rx NCSI commands */ 160 u32 ncsi_dropped_cmds; /* Dropped commands */ 161 u32 ncsi_cmd_type_errs; /* Command type errors */ 162 u32 ncsi_cmd_csum_errs; /* Command checksum errors */ 163 u32 ncsi_rx_pkts; /* Rx NCSI packets */ 164 u32 ncsi_tx_pkts; /* Tx NCSI packets */ 165 u32 ncsi_tx_aen_pkts; /* Tx AEN packets */ 166 u32 pt_tx_pkts; /* Tx packets */ 167 u32 pt_tx_dropped; /* Tx dropped packets */ 168 u32 pt_tx_channel_err; /* Tx channel errors */ 169 u32 pt_tx_us_err; /* Tx undersize errors */ 170 u32 pt_rx_pkts; /* Rx packets */ 171 u32 pt_rx_dropped; /* Rx dropped packets */ 172 u32 pt_rx_channel_err; /* Rx channel errors */ 173 u32 pt_rx_us_err; /* Rx undersize errors */ 174 u32 pt_rx_os_err; /* Rx oversize errors */ 175 }; 176 177 struct ncsi_dev_priv; 178 struct ncsi_package; 179 180 #define NCSI_PACKAGE_SHIFT 5 181 #define NCSI_PACKAGE_INDEX(c) (((c) >> NCSI_PACKAGE_SHIFT) & 0x7) 182 #define NCSI_RESERVED_CHANNEL 0x1f 183 #define NCSI_CHANNEL_INDEX(c) ((c) & ((1 << NCSI_PACKAGE_SHIFT) - 1)) 184 #define NCSI_TO_CHANNEL(p, c) (((p) << NCSI_PACKAGE_SHIFT) | (c)) 185 #define NCSI_MAX_PACKAGE 8 186 #define NCSI_MAX_CHANNEL 32 187 188 struct ncsi_channel { 189 unsigned char id; 190 int state; 191 #define NCSI_CHANNEL_INACTIVE 1 192 #define NCSI_CHANNEL_ACTIVE 2 193 #define NCSI_CHANNEL_INVISIBLE 3 194 bool reconfigure_needed; 195 spinlock_t lock; /* Protect filters etc */ 196 struct ncsi_package *package; 197 struct ncsi_channel_version version; 198 struct ncsi_channel_cap caps[NCSI_CAP_MAX]; 199 struct ncsi_channel_mode modes[NCSI_MODE_MAX]; 200 /* Filtering Settings */ 201 struct ncsi_channel_mac_filter mac_filter; 202 struct ncsi_channel_vlan_filter vlan_filter; 203 struct ncsi_channel_stats stats; 204 struct { 205 struct timer_list timer; 206 bool enabled; 207 unsigned int state; 208 #define NCSI_CHANNEL_MONITOR_START 0 209 #define NCSI_CHANNEL_MONITOR_RETRY 1 210 #define NCSI_CHANNEL_MONITOR_WAIT 2 211 #define NCSI_CHANNEL_MONITOR_WAIT_MAX 5 212 } monitor; 213 struct list_head node; 214 struct list_head link; 215 }; 216 217 struct ncsi_package { 218 unsigned char id; /* NCSI 3-bits package ID */ 219 unsigned char uuid[16]; /* UUID */ 220 struct ncsi_dev_priv *ndp; /* NCSI device */ 221 spinlock_t lock; /* Protect the package */ 222 unsigned int channel_num; /* Number of channels */ 223 struct list_head channels; /* List of chanels */ 224 struct list_head node; /* Form list of packages */ 225 }; 226 227 struct ncsi_request { 228 unsigned char id; /* Request ID - 0 to 255 */ 229 bool used; /* Request that has been assigned */ 230 unsigned int flags; /* NCSI request property */ 231 #define NCSI_REQ_FLAG_EVENT_DRIVEN 1 232 #define NCSI_REQ_FLAG_NETLINK_DRIVEN 2 233 struct ncsi_dev_priv *ndp; /* Associated NCSI device */ 234 struct sk_buff *cmd; /* Associated NCSI command packet */ 235 struct sk_buff *rsp; /* Associated NCSI response packet */ 236 struct timer_list timer; /* Timer on waiting for response */ 237 bool enabled; /* Time has been enabled or not */ 238 u32 snd_seq; /* netlink sending sequence number */ 239 u32 snd_portid; /* netlink portid of sender */ 240 struct nlmsghdr nlhdr; /* netlink message header */ 241 }; 242 243 enum { 244 ncsi_dev_state_major = 0xff00, 245 ncsi_dev_state_minor = 0x00ff, 246 ncsi_dev_state_probe_deselect = 0x0201, 247 ncsi_dev_state_probe_package, 248 ncsi_dev_state_probe_channel, 249 ncsi_dev_state_probe_cis, 250 ncsi_dev_state_probe_gvi, 251 ncsi_dev_state_probe_gc, 252 ncsi_dev_state_probe_gls, 253 ncsi_dev_state_probe_dp, 254 ncsi_dev_state_config_sp = 0x0301, 255 ncsi_dev_state_config_cis, 256 ncsi_dev_state_config_oem_gma, 257 ncsi_dev_state_config_clear_vids, 258 ncsi_dev_state_config_svf, 259 ncsi_dev_state_config_ev, 260 ncsi_dev_state_config_sma, 261 ncsi_dev_state_config_ebf, 262 #if IS_ENABLED(CONFIG_IPV6) 263 ncsi_dev_state_config_egmf, 264 #endif 265 ncsi_dev_state_config_ecnt, 266 ncsi_dev_state_config_ec, 267 ncsi_dev_state_config_ae, 268 ncsi_dev_state_config_gls, 269 ncsi_dev_state_config_done, 270 ncsi_dev_state_suspend_select = 0x0401, 271 ncsi_dev_state_suspend_gls, 272 ncsi_dev_state_suspend_dcnt, 273 ncsi_dev_state_suspend_dc, 274 ncsi_dev_state_suspend_deselect, 275 ncsi_dev_state_suspend_done 276 }; 277 278 struct vlan_vid { 279 struct list_head list; 280 __be16 proto; 281 u16 vid; 282 }; 283 284 struct ncsi_dev_priv { 285 struct ncsi_dev ndev; /* Associated NCSI device */ 286 unsigned int flags; /* NCSI device flags */ 287 #define NCSI_DEV_PROBED 1 /* Finalized NCSI topology */ 288 #define NCSI_DEV_HWA 2 /* Enabled HW arbitration */ 289 #define NCSI_DEV_RESHUFFLE 4 290 unsigned int gma_flag; /* OEM GMA flag */ 291 spinlock_t lock; /* Protect the NCSI device */ 292 #if IS_ENABLED(CONFIG_IPV6) 293 unsigned int inet6_addr_num; /* Number of IPv6 addresses */ 294 #endif 295 unsigned int package_num; /* Number of packages */ 296 struct list_head packages; /* List of packages */ 297 struct ncsi_channel *hot_channel; /* Channel was ever active */ 298 struct ncsi_package *force_package; /* Force a specific package */ 299 struct ncsi_channel *force_channel; /* Force a specific channel */ 300 struct ncsi_request requests[256]; /* Request table */ 301 unsigned int request_id; /* Last used request ID */ 302 #define NCSI_REQ_START_IDX 1 303 unsigned int pending_req_num; /* Number of pending requests */ 304 struct ncsi_package *active_package; /* Currently handled package */ 305 struct ncsi_channel *active_channel; /* Currently handled channel */ 306 struct list_head channel_queue; /* Config queue of channels */ 307 struct work_struct work; /* For channel management */ 308 struct packet_type ptype; /* NCSI packet Rx handler */ 309 struct list_head node; /* Form NCSI device list */ 310 #define NCSI_MAX_VLAN_VIDS 15 311 struct list_head vlan_vids; /* List of active VLAN IDs */ 312 }; 313 314 struct ncsi_cmd_arg { 315 struct ncsi_dev_priv *ndp; /* Associated NCSI device */ 316 unsigned char type; /* Command in the NCSI packet */ 317 unsigned char id; /* Request ID (sequence number) */ 318 unsigned char package; /* Destination package ID */ 319 unsigned char channel; /* Detination channel ID or 0x1f */ 320 unsigned short payload; /* Command packet payload length */ 321 unsigned int req_flags; /* NCSI request properties */ 322 union { 323 unsigned char bytes[16]; /* Command packet specific data */ 324 unsigned short words[8]; 325 unsigned int dwords[4]; 326 }; 327 unsigned char *data; /* NCSI OEM data */ 328 struct genl_info *info; /* Netlink information */ 329 }; 330 331 extern struct list_head ncsi_dev_list; 332 extern spinlock_t ncsi_dev_lock; 333 334 #define TO_NCSI_DEV_PRIV(nd) \ 335 container_of(nd, struct ncsi_dev_priv, ndev) 336 #define NCSI_FOR_EACH_DEV(ndp) \ 337 list_for_each_entry_rcu(ndp, &ncsi_dev_list, node) 338 #define NCSI_FOR_EACH_PACKAGE(ndp, np) \ 339 list_for_each_entry_rcu(np, &ndp->packages, node) 340 #define NCSI_FOR_EACH_CHANNEL(np, nc) \ 341 list_for_each_entry_rcu(nc, &np->channels, node) 342 343 /* Resources */ 344 void ncsi_start_channel_monitor(struct ncsi_channel *nc); 345 void ncsi_stop_channel_monitor(struct ncsi_channel *nc); 346 struct ncsi_channel *ncsi_find_channel(struct ncsi_package *np, 347 unsigned char id); 348 struct ncsi_channel *ncsi_add_channel(struct ncsi_package *np, 349 unsigned char id); 350 struct ncsi_package *ncsi_find_package(struct ncsi_dev_priv *ndp, 351 unsigned char id); 352 struct ncsi_package *ncsi_add_package(struct ncsi_dev_priv *ndp, 353 unsigned char id); 354 void ncsi_remove_package(struct ncsi_package *np); 355 void ncsi_find_package_and_channel(struct ncsi_dev_priv *ndp, 356 unsigned char id, 357 struct ncsi_package **np, 358 struct ncsi_channel **nc); 359 struct ncsi_request *ncsi_alloc_request(struct ncsi_dev_priv *ndp, 360 unsigned int req_flags); 361 void ncsi_free_request(struct ncsi_request *nr); 362 struct ncsi_dev *ncsi_find_dev(struct net_device *dev); 363 int ncsi_process_next_channel(struct ncsi_dev_priv *ndp); 364 365 /* Packet handlers */ 366 u32 ncsi_calculate_checksum(unsigned char *data, int len); 367 int ncsi_xmit_cmd(struct ncsi_cmd_arg *nca); 368 int ncsi_rcv_rsp(struct sk_buff *skb, struct net_device *dev, 369 struct packet_type *pt, struct net_device *orig_dev); 370 int ncsi_aen_handler(struct ncsi_dev_priv *ndp, struct sk_buff *skb); 371 372 #endif /* __NCSI_INTERNAL_H__ */ 373