xref: /freebsd/usr.sbin/bluetooth/ath3kfw/ath3k_hw.h (revision 5dae51da3da0cc94d17bd67b308fad304ebec7e0)
1 /*-
2  * Copyright (c) 2013 Adrian Chadd <adrian@freebsd.org>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer,
10  *    without modification.
11  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
12  *    similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any
13  *    redistribution must be conditioned upon including a substantially
14  *    similar Disclaimer requirement for further binary redistribution.
15  *
16  * NO WARRANTY
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19  * LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
20  * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
21  * THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY,
22  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
25  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
27  * THE POSSIBILITY OF SUCH DAMAGES.
28  *
29  * $FreeBSD$
30  */
31 #ifndef	__ATH3K_HW_H__
32 #define	__ATH3K_HW_H__
33 
34 #define	ATH3K_DNLOAD			0x01
35 #define	ATH3K_GETSTATE			0x05
36 #define	ATH3K_SET_NORMAL_MODE		0x07
37 #define	ATH3K_GETVERSION		0x09
38 #define	USB_REG_SWITCH_VID_PID		0x0a
39 
40 #define	ATH3K_MODE_MASK			0x3F
41 #define	ATH3K_NORMAL_MODE		0x0E
42 
43 #define	ATH3K_PATCH_UPDATE		0x80
44 #define	ATH3K_SYSCFG_UPDATE		0x40
45 
46 #define	ATH3K_XTAL_FREQ_26M		0x00
47 #define	ATH3K_XTAL_FREQ_40M		0x01
48 #define	ATH3K_XTAL_FREQ_19P2		0x02
49 #define	ATH3K_NAME_LEN			0xFF
50 
51 #define	USB_REQ_DFU_DNLOAD		1
52 #define	BULK_SIZE			4096
53 #define	FW_HDR_SIZE			20
54 
55 extern	int ath3k_load_fwfile(struct libusb_device_handle *hdl,
56 	    const struct ath3k_firmware *fw);
57 extern	int ath3k_get_state(struct libusb_device_handle *hdl,
58 	    unsigned char *state);
59 extern	int ath3k_get_version(struct libusb_device_handle *hdl,
60 	    struct ath3k_version *version);
61 extern	int ath3k_load_patch(libusb_device_handle *hdl, const char *fw_path);
62 extern	int ath3k_load_syscfg(libusb_device_handle *hdl, const char *fw_path);
63 extern	int ath3k_set_normal_mode(libusb_device_handle *hdl);
64 extern	int ath3k_switch_pid(libusb_device_handle *hdl);
65 
66 #endif
67