xref: /freebsd/usr.sbin/bluetooth/iwmbtfw/iwmbt_hw.h (revision 38effe887ee979f91ad5abf42a2291558e7ff8d1)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2019 Vladimir Kondratyev <wulf@FreeBSD.org>
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  *
27  * $FreeBSD$
28  */
29 #ifndef	__IWMBT_HW_H__
30 #define	__IWMBT_HW_H__
31 
32 /* USB control request (HCI command) structure */
33 struct iwmbt_hci_cmd {
34 	uint16_t	opcode;
35 	uint8_t		length;
36 	uint8_t		data[];
37 } __attribute__ ((packed));
38 
39 #define IWMBT_HCI_CMD_SIZE(cmd) \
40 	((cmd)->length + offsetof(struct iwmbt_hci_cmd, data))
41 
42 /* USB interrupt transfer HCI event header structure */
43 struct iwmbt_hci_evhdr {
44 	uint8_t		event;
45 	uint8_t		length;
46 } __attribute__ ((packed));
47 
48 /* USB interrupt transfer (generic HCI event) structure */
49 struct iwmbt_hci_event {
50 	struct iwmbt_hci_evhdr	header;
51 	uint8_t			data[];
52 } __attribute__ ((packed));
53 
54 /* USB interrupt transfer (HCI command completion event) structure */
55 struct iwmbt_hci_event_cmd_compl {
56 	struct iwmbt_hci_evhdr	header;
57 	uint8_t			numpkt;
58 	uint16_t		opcode;
59 	uint8_t			data[];
60 } __attribute__ ((packed));
61 
62 #define IWMBT_HCI_EVT_COMPL_SIZE(payload) \
63 	(offsetof(struct iwmbt_hci_event_cmd_compl, data) + sizeof(payload))
64 
65 #define	IWMBT_CONTROL_ENDPOINT_ADDR	0x00
66 #define	IWMBT_INTERRUPT_ENDPOINT_ADDR	0x81
67 #define	IWMBT_BULK_IN_ENDPOINT_ADDR	0x82
68 #define	IWMBT_BULK_OUT_ENDPOINT_ADDR	0x02
69 
70 #define	IWMBT_HCI_MAX_CMD_SIZE		256
71 #define	IWMBT_HCI_MAX_EVENT_SIZE	16
72 
73 #define	IWMBT_HCI_CMD_TIMEOUT		2000	/* ms */
74 #define	IWMBT_LOADCMPL_TIMEOUT		5000	/* ms */
75 
76 extern	int iwmbt_load_fwfile(struct libusb_device_handle *hdl,
77 	    const struct iwmbt_firmware *fw, uint32_t *boot_param);
78 extern	int iwmbt_get_version(struct libusb_device_handle *hdl,
79 	    struct iwmbt_version *version);
80 extern	int iwmbt_get_boot_params(struct libusb_device_handle *hdl,
81 	    struct iwmbt_boot_params *params);
82 extern	int iwmbt_intel_reset(struct libusb_device_handle *hdl,
83 	    uint32_t boot_param);
84 extern	int iwmbt_load_ddc(struct libusb_device_handle *hdl,
85 	    const struct iwmbt_firmware *ddc);
86 extern	int iwmbt_set_event_mask(struct libusb_device_handle *hdl);
87 
88 #endif
89