Home | History | Annotate | Line # | Download | only in ic
bwfmvar.h revision 1.14 
      1 /* $NetBSD: bwfmvar.h,v 1.14 2022/12/03 16:06:20 mlelstv Exp $ */
      2 /* $OpenBSD: bwfmvar.h,v 1.1 2017/10/11 17:19:50 patrick Exp $ */
      3 /*
      4  * Copyright (c) 2010-2016 Broadcom Corporation
      5  * Copyright (c) 2016,2017 Patrick Wildt <patrick (at) blueri.se>
      6  *
      7  * Permission to use, copy, modify, and/or distribute this software for any
      8  * purpose with or without fee is hereby granted, provided that the above
      9  * copyright notice and this permission notice appear in all copies.
     10  *
     11  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
     12  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
     13  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
     14  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
     15  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
     16  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
     17  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
     18  */
     19 
     20 #ifndef	_DEV_IC_BWFMVAR_H
     21 #define	_DEV_IC_BWFMVAR_H
     22 
     23 #include <sys/types.h>
     24 
     25 #include <sys/cdefs.h>
     26 #include <sys/device_if.h>
     27 #include <sys/queue.h>
     28 #include <sys/workqueue.h>
     29 
     30 #include <net/if_ether.h>
     31 
     32 #include <net80211/ieee80211.h>
     33 #include <net80211/ieee80211_proto.h>
     34 #include <net80211/ieee80211_var.h>
     35 
     36 struct ieee80211_key;
     37 struct mbuf;
     38 struct pool_cache;
     39 
     40 /* Chipcommon Core Chip IDs */
     41 #define BRCM_CC_43143_CHIP_ID		43143
     42 #define BRCM_CC_43235_CHIP_ID		43235
     43 #define BRCM_CC_43236_CHIP_ID		43236
     44 #define BRCM_CC_43238_CHIP_ID		43238
     45 #define BRCM_CC_43241_CHIP_ID		0x4324
     46 #define BRCM_CC_43242_CHIP_ID		43242
     47 #define BRCM_CC_4329_CHIP_ID		0x4329
     48 #define BRCM_CC_4330_CHIP_ID		0x4330
     49 #define BRCM_CC_4334_CHIP_ID		0x4334
     50 #define BRCM_CC_43340_CHIP_ID		43340
     51 #define BRCM_CC_43341_CHIP_ID		43341
     52 #define BRCM_CC_43362_CHIP_ID		43362
     53 #define BRCM_CC_43364_CHIP_ID		43364
     54 #define BRCM_CC_4335_CHIP_ID		0x4335
     55 #define BRCM_CC_4339_CHIP_ID		0x4339
     56 #define BRCM_CC_43430_CHIP_ID		43430
     57 #define BRCM_CC_4345_CHIP_ID		0x4345
     58 #define BRCM_CC_43465_CHIP_ID		43465
     59 #define BRCM_CC_4350_CHIP_ID		0x4350
     60 #define BRCM_CC_43525_CHIP_ID		43525
     61 #define BRCM_CC_4354_CHIP_ID		0x4354
     62 #define BRCM_CC_4356_CHIP_ID		0x4356
     63 #define BRCM_CC_43566_CHIP_ID		43566
     64 #define BRCM_CC_43567_CHIP_ID		43567
     65 #define BRCM_CC_43569_CHIP_ID		43569
     66 #define BRCM_CC_43570_CHIP_ID		43570
     67 #define BRCM_CC_4358_CHIP_ID		0x4358
     68 #define BRCM_CC_4359_CHIP_ID		0x4359
     69 #define BRCM_CC_43602_CHIP_ID		43602
     70 #define BRCM_CC_4365_CHIP_ID		0x4365
     71 #define BRCM_CC_4366_CHIP_ID		0x4366
     72 #define BRCM_CC_43664_CHIP_ID		43664
     73 #define BRCM_CC_4371_CHIP_ID		0x4371
     74 #define CY_CC_4373_CHIP_ID		0x4373
     75 #define CY_CC_43012_CHIP_ID		43012
     76 
     77 /* Defaults */
     78 #define BWFM_DEFAULT_SCAN_CHANNEL_TIME	40
     79 #define BWFM_DEFAULT_SCAN_UNASSOC_TIME	40
     80 #define BWFM_DEFAULT_SCAN_PASSIVE_TIME	120
     81 
     82 #define	BWFM_TASK_COUNT			256
     83 
     84 struct bwfm_softc;
     85 
     86 struct bwfm_firmware_selector {
     87 	uint32_t	fwsel_chip;	/* chip ID */
     88 	uint32_t	fwsel_revmask;	/* mask of applicable chip revs */
     89 	const char	*fwsel_basename;/* firmware file base name */
     90 };
     91 #define	BWFM_FW_ENTRY(c, r, b)						\
     92 	{ .fwsel_chip = (c),						\
     93 	  .fwsel_revmask = (r),						\
     94 	  .fwsel_basename = b }
     95 
     96 #define	BWFM_FW_ENTRY_END						\
     97 	{ .fwsel_basename = NULL }
     98 
     99 #define	BWFM_FWSEL_REV_EQ(x)	__BIT(x)
    100 #define	BWFM_FWSEL_REV_LE(x)	__BITS(0,x)
    101 #define	BWFM_FWSEL_REV_GE(x)	__BITS(x,31)
    102 #define	BWFM_FWSEL_ALLREVS	__BITS(0,31)
    103 
    104 #define	BWFM_FILETYPE_UCODE	0
    105 #define	BWFM_FILETYPE_NVRAM	1
    106 #define	BWFM_FILETYPE_CLM	2
    107 #define	BWFM_FILETYPE_TXCAP	3
    108 #define	BWFM_FILETYPE_CAL	4
    109 #define	BWFM_NFILETYPES		5
    110 
    111 struct bwfm_firmware_context {
    112 	/* inputs */
    113 	uint32_t	ctx_chip;
    114 	uint32_t	ctx_chiprev;
    115 	const char *	ctx_model;
    116 	uint32_t	ctx_req;
    117 
    118 #define	BWFM_FWREQ(x)		__BIT(x)
    119 #define	BWFM_FWOPT(x)		__BIT((x)+16)
    120 
    121 	/* outputs */
    122 	struct {
    123 		void *	ctx_f_data;
    124 		size_t	ctx_f_size;
    125 	} ctx_file[BWFM_NFILETYPES];
    126 };
    127 
    128 struct bwfm_core {
    129 	uint16_t	 co_id;
    130 	uint16_t	 co_rev;
    131 	uint32_t	 co_base;
    132 	uint32_t	 co_wrapbase;
    133 	LIST_ENTRY(bwfm_core) co_link;
    134 };
    135 
    136 struct bwfm_chip {
    137 	uint32_t	 ch_chip;
    138 	uint32_t	 ch_chiprev;
    139 	uint32_t	 ch_cc_caps;
    140 	uint32_t	 ch_cc_caps_ext;
    141 	uint32_t	 ch_pmucaps;
    142 	uint32_t	 ch_pmurev;
    143 	uint32_t	 ch_rambase;
    144 	uint32_t	 ch_ramsize;
    145 	uint32_t	 ch_srsize;
    146 	char		 ch_name[8];
    147 	LIST_HEAD(,bwfm_core) ch_list;
    148 	int (*ch_core_isup)(struct bwfm_softc *, struct bwfm_core *);
    149 	void (*ch_core_disable)(struct bwfm_softc *, struct bwfm_core *,
    150 	    uint32_t prereset, uint32_t reset);
    151 	void (*ch_core_reset)(struct bwfm_softc *, struct bwfm_core *,
    152 	    uint32_t prereset, uint32_t reset, uint32_t postreset);
    153 };
    154 
    155 struct bwfm_bus_ops {
    156 	void (*bs_init)(struct bwfm_softc *);
    157 	void (*bs_stop)(struct bwfm_softc *);
    158 	int (*bs_txcheck)(struct bwfm_softc *);
    159 	int (*bs_txdata)(struct bwfm_softc *, struct mbuf **);
    160 	int (*bs_txctl)(struct bwfm_softc *, char *, size_t);
    161 	int (*bs_rxctl)(struct bwfm_softc *, char *, size_t *);
    162 };
    163 
    164 struct bwfm_buscore_ops {
    165 	uint32_t (*bc_read)(struct bwfm_softc *, uint32_t);
    166 	void (*bc_write)(struct bwfm_softc *, uint32_t, uint32_t);
    167 	int (*bc_prepare)(struct bwfm_softc *);
    168 	int (*bc_reset)(struct bwfm_softc *);
    169 	int (*bc_setup)(struct bwfm_softc *);
    170 	void (*bc_activate)(struct bwfm_softc *, const uint32_t);
    171 };
    172 
    173 struct bwfm_proto_ops {
    174 	int (*proto_query_dcmd)(struct bwfm_softc *, int, int,
    175 	    char *, size_t *);
    176 	int (*proto_set_dcmd)(struct bwfm_softc *, int, int,
    177 	    char *, size_t);
    178 };
    179 extern const struct bwfm_proto_ops bwfm_proto_bcdc_ops;
    180 
    181 enum bwfm_task_cmd {
    182 	BWFM_TASK_NEWSTATE,
    183 	BWFM_TASK_KEY_SET,
    184 	BWFM_TASK_KEY_DELETE,
    185 	BWFM_TASK_RX_EVENT,
    186 };
    187 
    188 struct bwfm_cmd_newstate {
    189 	enum ieee80211_state	 state;
    190 	int			 arg;
    191 };
    192 
    193 struct bwfm_cmd_key {
    194 	const struct ieee80211_key *key;
    195 	uint8_t			 mac[IEEE80211_ADDR_LEN];
    196 };
    197 
    198 struct bwfm_task {
    199 	struct work		 t_work;
    200 	struct bwfm_softc	*t_sc;
    201 	enum bwfm_task_cmd	 t_cmd;
    202 	union {
    203 		struct bwfm_cmd_newstate	newstate;
    204 		struct bwfm_cmd_key		key;
    205 		struct mbuf			*mbuf;
    206 	} t_u;
    207 #define	t_newstate	t_u.newstate
    208 #define	t_key		t_u.key
    209 #define	t_mbuf		t_u.mbuf
    210 };
    211 
    212 struct bwfm_softc {
    213 	device_t		 sc_dev;
    214 	struct ieee80211com	 sc_ic;
    215 	struct ethercom		 sc_ec;
    216 #define	sc_if			 sc_ec.ec_if
    217 
    218 	const struct bwfm_bus_ops	*sc_bus_ops;
    219 	const struct bwfm_buscore_ops	*sc_buscore_ops;
    220 	const struct bwfm_proto_ops	*sc_proto_ops;
    221 	struct bwfm_chip	 sc_chip;
    222 	uint8_t			 sc_io_type;
    223 #define		BWFM_IO_TYPE_D11N		1
    224 #define		BWFM_IO_TYPE_D11AC		2
    225 
    226 	int			 sc_tx_timer;
    227 
    228 	bool			 sc_if_attached;
    229 	struct pool_cache	*sc_freetask;
    230 	struct workqueue	*sc_taskq;
    231 
    232 	int			(*sc_newstate)(struct ieee80211com *,
    233 				    enum ieee80211_state, int);
    234 
    235 	int			 sc_bcdc_reqid;
    236 
    237 	union {
    238 		struct bwfm_bss_info bss_info;
    239 		uint8_t padding[BWFM_BSS_INFO_BUFLEN];
    240 	}			sc_bss_buf;
    241 
    242 	uint8_t			*sc_clm;
    243 	size_t			sc_clmsize;
    244 	uint8_t			*sc_txcap;
    245 	size_t			sc_txcapsize;
    246 	uint8_t			*sc_cal;
    247 	size_t			sc_calsize;
    248 
    249 	int			sc_pm;
    250 	bool			sc_setpm;
    251 };
    252 
    253 void bwfm_attach(struct bwfm_softc *);
    254 void bwfm_chip_socram_ramsize(struct bwfm_softc *, struct bwfm_core *);
    255 void bwfm_chip_sysmem_ramsize(struct bwfm_softc *, struct bwfm_core *);
    256 void bwfm_chip_tcm_ramsize(struct bwfm_softc *, struct bwfm_core *);
    257 void bwfm_chip_tcm_rambase(struct bwfm_softc *);
    258 void bwfm_start(struct ifnet *);
    259 int bwfm_detach(struct bwfm_softc *, int);
    260 int bwfm_chip_attach(struct bwfm_softc *);
    261 int bwfm_chip_set_active(struct bwfm_softc *, uint32_t);
    262 void bwfm_chip_set_passive(struct bwfm_softc *);
    263 int bwfm_chip_sr_capable(struct bwfm_softc *);
    264 struct bwfm_core *bwfm_chip_get_core(struct bwfm_softc *, int);
    265 struct bwfm_core *bwfm_chip_get_pmu(struct bwfm_softc *);
    266 void bwfm_rx(struct bwfm_softc *, struct mbuf *m);
    267 
    268 void	bwfm_firmware_context_init(struct bwfm_firmware_context *,
    269 	    uint32_t, uint32_t, const char *, uint32_t);
    270 bool	bwfm_firmware_open(struct bwfm_softc *,
    271 	    const struct bwfm_firmware_selector *,
    272 	    struct bwfm_firmware_context *);
    273 void	bwfm_firmware_close(struct bwfm_firmware_context *);
    274 void *	bwfm_firmware_data(struct bwfm_firmware_context *,
    275 	    unsigned int, size_t *);
    276 const char *bwfm_firmware_description(unsigned int);
    277 
    278 #endif	/* _DEV_IC_BWFMVAR_H */
    279