bwfmvar.h revision 1.4
1/* $NetBSD: bwfmvar.h,v 1.4 2019/09/01 05:40:39 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@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#include <sys/pcq.h>
21
22/* Chipcommon Core Chip IDs */
23#define BRCM_CC_43143_CHIP_ID		43143
24#define BRCM_CC_43235_CHIP_ID		43235
25#define BRCM_CC_43236_CHIP_ID		43236
26#define BRCM_CC_43238_CHIP_ID		43238
27#define BRCM_CC_43241_CHIP_ID		0x4324
28#define BRCM_CC_43242_CHIP_ID		43242
29#define BRCM_CC_4329_CHIP_ID		0x4329
30#define BRCM_CC_4330_CHIP_ID		0x4330
31#define BRCM_CC_4334_CHIP_ID		0x4334
32#define BRCM_CC_43340_CHIP_ID		43340
33#define BRCM_CC_43362_CHIP_ID		43362
34#define BRCM_CC_4335_CHIP_ID		0x4335
35#define BRCM_CC_4339_CHIP_ID		0x4339
36#define BRCM_CC_43430_CHIP_ID		43430
37#define BRCM_CC_4345_CHIP_ID		0x4345
38#define BRCM_CC_43465_CHIP_ID		43465
39#define BRCM_CC_4350_CHIP_ID		0x4350
40#define BRCM_CC_43525_CHIP_ID		43525
41#define BRCM_CC_4354_CHIP_ID		0x4354
42#define BRCM_CC_4356_CHIP_ID		0x4356
43#define BRCM_CC_43566_CHIP_ID		43566
44#define BRCM_CC_43567_CHIP_ID		43567
45#define BRCM_CC_43569_CHIP_ID		43569
46#define BRCM_CC_43570_CHIP_ID		43570
47#define BRCM_CC_4358_CHIP_ID		0x4358
48#define BRCM_CC_4359_CHIP_ID		0x4359
49#define BRCM_CC_43602_CHIP_ID		43602
50#define BRCM_CC_4365_CHIP_ID		0x4365
51#define BRCM_CC_4366_CHIP_ID		0x4366
52#define BRCM_CC_4371_CHIP_ID		0x4371
53#define CY_CC_4373_CHIP_ID		0x4373
54
55/* Defaults */
56#define BWFM_DEFAULT_SCAN_CHANNEL_TIME	40
57#define BWFM_DEFAULT_SCAN_UNASSOC_TIME	40
58#define BWFM_DEFAULT_SCAN_PASSIVE_TIME	120
59
60#define	BWFM_TASK_COUNT			256
61
62
63struct bwfm_softc;
64
65struct bwfm_core {
66	uint16_t	 co_id;
67	uint16_t	 co_rev;
68	uint32_t	 co_base;
69	uint32_t	 co_wrapbase;
70	LIST_ENTRY(bwfm_core) co_link;
71};
72
73struct bwfm_chip {
74	uint32_t	 ch_chip;
75	uint32_t	 ch_chiprev;
76	uint32_t	 ch_cc_caps;
77	uint32_t	 ch_cc_caps_ext;
78	uint32_t	 ch_pmucaps;
79	uint32_t	 ch_pmurev;
80	uint32_t	 ch_rambase;
81	uint32_t	 ch_ramsize;
82	uint32_t	 ch_srsize;
83	char		 ch_name[8];
84	LIST_HEAD(,bwfm_core) ch_list;
85	int (*ch_core_isup)(struct bwfm_softc *, struct bwfm_core *);
86	void (*ch_core_disable)(struct bwfm_softc *, struct bwfm_core *,
87	    uint32_t prereset, uint32_t reset);
88	void (*ch_core_reset)(struct bwfm_softc *, struct bwfm_core *,
89	    uint32_t prereset, uint32_t reset, uint32_t postreset);
90};
91
92struct bwfm_bus_ops {
93	void (*bs_init)(struct bwfm_softc *);
94	void (*bs_stop)(struct bwfm_softc *);
95	int (*bs_txcheck)(struct bwfm_softc *);
96	int (*bs_txdata)(struct bwfm_softc *, struct mbuf **);
97	int (*bs_txctl)(struct bwfm_softc *, char *, size_t);
98	int (*bs_rxctl)(struct bwfm_softc *, char *, size_t *);
99};
100
101struct bwfm_buscore_ops {
102	uint32_t (*bc_read)(struct bwfm_softc *, uint32_t);
103	void (*bc_write)(struct bwfm_softc *, uint32_t, uint32_t);
104	int (*bc_prepare)(struct bwfm_softc *);
105	int (*bc_reset)(struct bwfm_softc *);
106	int (*bc_setup)(struct bwfm_softc *);
107	void (*bc_activate)(struct bwfm_softc *, const uint32_t);
108};
109
110struct bwfm_proto_ops {
111	int (*proto_query_dcmd)(struct bwfm_softc *, int, int,
112	    char *, size_t *);
113	int (*proto_set_dcmd)(struct bwfm_softc *, int, int,
114	    char *, size_t);
115};
116extern struct bwfm_proto_ops bwfm_proto_bcdc_ops;
117
118enum bwfm_task_cmd {
119	BWFM_TASK_NEWSTATE,
120	BWFM_TASK_KEY_SET,
121	BWFM_TASK_KEY_DELETE,
122	BWFM_TASK_RX_EVENT,
123};
124
125struct bwfm_cmd_newstate {
126	enum ieee80211_state	 state;
127	int			 arg;
128};
129
130struct bwfm_cmd_key {
131	const struct ieee80211_key *key;
132	uint8_t			 mac[IEEE80211_ADDR_LEN];
133};
134
135struct bwfm_task {
136	struct work		 t_work;
137	struct bwfm_softc	*t_sc;
138	enum bwfm_task_cmd	 t_cmd;
139	union {
140		struct bwfm_cmd_newstate	newstate;
141		struct bwfm_cmd_key		key;
142		struct mbuf			*mbuf;
143	} t_u;
144#define	t_newstate	t_u.newstate
145#define	t_key		t_u.key
146#define	t_mbuf		t_u.mbuf
147};
148
149struct bwfm_softc {
150	device_t		 sc_dev;
151	struct ieee80211com	 sc_ic;
152	struct ethercom		 sc_ec;
153#define	sc_if			 sc_ec.ec_if
154
155	struct bwfm_bus_ops	*sc_bus_ops;
156	struct bwfm_buscore_ops	*sc_buscore_ops;
157	struct bwfm_proto_ops	*sc_proto_ops;
158	struct bwfm_chip	 sc_chip;
159	uint8_t			 sc_io_type;
160#define		BWFM_IO_TYPE_D11N		1
161#define		BWFM_IO_TYPE_D11AC		2
162
163	int			 sc_tx_timer;
164
165	bool			 sc_if_attached;
166	struct bwfm_task	 sc_task[BWFM_TASK_COUNT];
167	pcq_t			*sc_freetask;
168	struct workqueue	*sc_taskq;
169
170	int			(*sc_newstate)(struct ieee80211com *,
171				    enum ieee80211_state, int);
172};
173
174void bwfm_attach(struct bwfm_softc *);
175void bwfm_chip_socram_ramsize(struct bwfm_softc *, struct bwfm_core *);
176void bwfm_chip_sysmem_ramsize(struct bwfm_softc *, struct bwfm_core *);
177void bwfm_chip_tcm_ramsize(struct bwfm_softc *, struct bwfm_core *);
178void bwfm_chip_tcm_rambase(struct bwfm_softc *);
179void bwfm_start(struct ifnet *);
180int bwfm_detach(struct bwfm_softc *, int);
181int bwfm_chip_attach(struct bwfm_softc *);
182int bwfm_chip_set_active(struct bwfm_softc *, uint32_t);
183void bwfm_chip_set_passive(struct bwfm_softc *);
184int bwfm_chip_sr_capable(struct bwfm_softc *);
185struct bwfm_core *bwfm_chip_get_core(struct bwfm_softc *, int);
186struct bwfm_core *bwfm_chip_get_pmu(struct bwfm_softc *);
187void bwfm_rx(struct bwfm_softc *, struct mbuf *m);
188