xref: /freebsd/sys/dev/bwi/bwimac.h (revision 0b57cec536236d46e3dba9bd041533462f33dbb7)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 2007 The DragonFly Project.  All rights reserved.
5  *
6  * This code is derived from software contributed to The DragonFly Project
7  * by Sepherosa Ziehau <sepherosa@gmail.com>
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in
17  *    the documentation and/or other materials provided with the
18  *    distribution.
19  * 3. Neither the name of The DragonFly Project nor the names of its
20  *    contributors may be used to endorse or promote products derived
21  *    from this software without specific, prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
26  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
27  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
28  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
29  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
30  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
31  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
32  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
33  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34  * SUCH DAMAGE.
35  *
36  * $DragonFly: src/sys/dev/netif/bwi/bwimac.h,v 1.2 2008/02/15 11:15:38 sephe Exp $
37  * $FreeBSD$
38  */
39 
40 #ifndef _BWI_MAC_H
41 #define _BWI_MAC_H
42 
43 int		bwi_mac_attach(struct bwi_softc *, int, uint8_t);
44 int		bwi_mac_lateattach(struct bwi_mac *);
45 void		bwi_mac_detach(struct bwi_mac *);
46 int		bwi_mac_init(struct bwi_mac *);
47 void		bwi_mac_reset(struct bwi_mac *, int);
48 int		bwi_mac_start(struct bwi_mac *);
49 int		bwi_mac_stop(struct bwi_mac *);
50 void		bwi_mac_shutdown(struct bwi_mac *);
51 void		bwi_mac_updateslot(struct bwi_mac *, int);
52 void		bwi_mac_set_promisc(struct bwi_mac *, int);
53 
54 void		bwi_mac_calibrate_txpower(struct bwi_mac *,
55 					  enum bwi_txpwrcb_type);
56 void		bwi_mac_set_tpctl_11bg(struct bwi_mac *,
57 				       const struct bwi_tpctl *);
58 void		bwi_mac_init_tpctl_11bg(struct bwi_mac *);
59 void		bwi_mac_dummy_xmit(struct bwi_mac *);
60 void		bwi_mac_reset_hwkeys(struct bwi_mac *);
61 int		bwi_mac_config_ps(struct bwi_mac *);
62 int		bwi_mac_fw_alloc(struct bwi_mac *);
63 
64 uint16_t	bwi_memobj_read_2(struct bwi_mac *, uint16_t, uint16_t);
65 uint32_t	bwi_memobj_read_4(struct bwi_mac *, uint16_t, uint16_t);
66 void		bwi_memobj_write_2(struct bwi_mac *, uint16_t, uint16_t,
67 				   uint16_t);
68 void		bwi_memobj_write_4(struct bwi_mac *, uint16_t, uint16_t,
69 				   uint32_t);
70 void		bwi_tmplt_write_4(struct bwi_mac *, uint32_t, uint32_t);
71 void		bwi_hostflags_write(struct bwi_mac *, uint64_t);
72 uint64_t	bwi_hostflags_read(struct bwi_mac *);
73 
74 #define MOBJ_WRITE_2(mac, objid, ofs, val)	\
75 	bwi_memobj_write_2((mac), (objid), (ofs), (val))
76 #define MOBJ_WRITE_4(mac, objid, ofs, val)	\
77 	bwi_memobj_write_4((mac), (objid), (ofs), (val))
78 #define MOBJ_READ_2(mac, objid, ofs)		\
79 	bwi_memobj_read_2((mac), (objid), (ofs))
80 #define MOBJ_READ_4(mac, objid, ofs)		\
81 	bwi_memobj_read_4((mac), (objid), (ofs))
82 
83 #define MOBJ_SETBITS_4(mac, objid, ofs, bits)	\
84 	MOBJ_WRITE_4((mac), (objid), (ofs),	\
85 		     MOBJ_READ_4((mac), (objid), (ofs)) | (bits))
86 #define MOBJ_CLRBITS_4(mac, objid, ofs, bits)	\
87 	MOBJ_WRITE_4((mac), (objid), (ofs),	\
88 		     MOBJ_READ_4((mac), (objid), (ofs)) & ~(bits))
89 
90 #define MOBJ_FILT_SETBITS_2(mac, objid, ofs, filt, bits) \
91 	MOBJ_WRITE_2((mac), (objid), (ofs),	\
92 		     (MOBJ_READ_2((mac), (objid), (ofs)) & (filt)) | (bits))
93 
94 #define TMPLT_WRITE_4(mac, ofs, val)	bwi_tmplt_write_4((mac), (ofs), (val))
95 
96 #define HFLAGS_WRITE(mac, flags)	bwi_hostflags_write((mac), (flags))
97 #define HFLAGS_READ(mac)		bwi_hostflags_read((mac))
98 #define HFLAGS_CLRBITS(mac, bits)	\
99 	HFLAGS_WRITE((mac), HFLAGS_READ((mac)) | (bits))
100 #define HFLAGS_SETBITS(mac, bits)	\
101 	HFLAGS_WRITE((mac), HFLAGS_READ((mac)) & ~(bits))
102 
103 #endif	/* !_BWI_MAC_H */
104