xref: /openbmc/linux/drivers/net/ieee802154/atusb.h (revision 7490b008d123f9bd781f51ad86b543aed49f6200)
1*7490b008SAlexander Aring /*
2*7490b008SAlexander Aring  * atusb.h - Definitions shared between kernel and ATUSB firmware
3*7490b008SAlexander Aring  *
4*7490b008SAlexander Aring  * Written 2013 by Werner Almesberger <werner@almesberger.net>
5*7490b008SAlexander Aring  *
6*7490b008SAlexander Aring  * This program is free software; you can redistribute it and/or
7*7490b008SAlexander Aring  * modify it under the terms of the GNU General Public License as
8*7490b008SAlexander Aring  * published by the Free Software Foundation, version 2, or
9*7490b008SAlexander Aring  * (at your option) any later version.
10*7490b008SAlexander Aring  *
11*7490b008SAlexander Aring  * This file should be identical for kernel and firmware.
12*7490b008SAlexander Aring  * Kernel: drivers/net/ieee802154/atusb.h
13*7490b008SAlexander Aring  * Firmware: ben-wpan/atusb/fw/include/atusb/atusb.h
14*7490b008SAlexander Aring  */
15*7490b008SAlexander Aring 
16*7490b008SAlexander Aring #ifndef _ATUSB_H
17*7490b008SAlexander Aring #define _ATUSB_H
18*7490b008SAlexander Aring 
19*7490b008SAlexander Aring #define ATUSB_VENDOR_ID	0x20b7	/* Qi Hardware*/
20*7490b008SAlexander Aring #define ATUSB_PRODUCT_ID 0x1540	/* 802.15.4, device 0 */
21*7490b008SAlexander Aring 				/*     -- -         - */
22*7490b008SAlexander Aring 
23*7490b008SAlexander Aring #define ATUSB_BUILD_SIZE 256	/* maximum build version/date message length */
24*7490b008SAlexander Aring 
25*7490b008SAlexander Aring /* Commands to our device. Make sure this is synced with the firmware */
26*7490b008SAlexander Aring enum atusb_requests {
27*7490b008SAlexander Aring 	ATUSB_ID			= 0x00,	/* system status/control grp */
28*7490b008SAlexander Aring 	ATUSB_BUILD,
29*7490b008SAlexander Aring 	ATUSB_RESET,
30*7490b008SAlexander Aring 	ATUSB_RF_RESET			= 0x10,	/* debug/test group */
31*7490b008SAlexander Aring 	ATUSB_POLL_INT,
32*7490b008SAlexander Aring 	ATUSB_TEST,			/* atusb-sil only */
33*7490b008SAlexander Aring 	ATUSB_TIMER,
34*7490b008SAlexander Aring 	ATUSB_GPIO,
35*7490b008SAlexander Aring 	ATUSB_SLP_TR,
36*7490b008SAlexander Aring 	ATUSB_GPIO_CLEANUP,
37*7490b008SAlexander Aring 	ATUSB_REG_WRITE			= 0x20,	/* transceiver group */
38*7490b008SAlexander Aring 	ATUSB_REG_READ,
39*7490b008SAlexander Aring 	ATUSB_BUF_WRITE,
40*7490b008SAlexander Aring 	ATUSB_BUF_READ,
41*7490b008SAlexander Aring 	ATUSB_SRAM_WRITE,
42*7490b008SAlexander Aring 	ATUSB_SRAM_READ,
43*7490b008SAlexander Aring 	ATUSB_SPI_WRITE			= 0x30,	/* SPI group */
44*7490b008SAlexander Aring 	ATUSB_SPI_READ1,
45*7490b008SAlexander Aring 	ATUSB_SPI_READ2,
46*7490b008SAlexander Aring 	ATUSB_SPI_WRITE2_SYNC,
47*7490b008SAlexander Aring 	ATUSB_RX_MODE			= 0x40, /* HardMAC group */
48*7490b008SAlexander Aring 	ATUSB_TX,
49*7490b008SAlexander Aring };
50*7490b008SAlexander Aring 
51*7490b008SAlexander Aring /* Direction	bRequest		wValue		wIndex	wLength
52*7490b008SAlexander Aring  *
53*7490b008SAlexander Aring  * ->host	ATUSB_ID		-		-	3
54*7490b008SAlexander Aring  * ->host	ATUSB_BUILD		-		-	#bytes
55*7490b008SAlexander Aring  * host->	ATUSB_RESET		-		-	0
56*7490b008SAlexander Aring  *
57*7490b008SAlexander Aring  * host->	ATUSB_RF_RESET		-		-	0
58*7490b008SAlexander Aring  * ->host	ATUSB_POLL_INT		-		-	1
59*7490b008SAlexander Aring  * host->	ATUSB_TEST		-		-	0
60*7490b008SAlexander Aring  * ->host	ATUSB_TIMER		-		-	#bytes (6)
61*7490b008SAlexander Aring  * ->host	ATUSB_GPIO		dir+data	mask+p#	3
62*7490b008SAlexander Aring  * host->	ATUSB_SLP_TR		-		-	0
63*7490b008SAlexander Aring  * host->	ATUSB_GPIO_CLEANUP	-		-	0
64*7490b008SAlexander Aring  *
65*7490b008SAlexander Aring  * host->	ATUSB_REG_WRITE		value		addr	0
66*7490b008SAlexander Aring  * ->host	ATUSB_REG_READ		-		addr	1
67*7490b008SAlexander Aring  * host->	ATUSB_BUF_WRITE		-		-	#bytes
68*7490b008SAlexander Aring  * ->host	ATUSB_BUF_READ		-		-	#bytes
69*7490b008SAlexander Aring  * host->	ATUSB_SRAM_WRITE	-		addr	#bytes
70*7490b008SAlexander Aring  * ->host	ATUSB_SRAM_READ		-		addr	#bytes
71*7490b008SAlexander Aring  *
72*7490b008SAlexander Aring  * host->	ATUSB_SPI_WRITE		byte0		byte1	#bytes
73*7490b008SAlexander Aring  * ->host	ATUSB_SPI_READ1		byte0		-	#bytes
74*7490b008SAlexander Aring  * ->host	ATUSB_SPI_READ2		byte0		byte1	#bytes
75*7490b008SAlexander Aring  * ->host	ATUSB_SPI_WRITE2_SYNC	byte0		byte1	0/1
76*7490b008SAlexander Aring  *
77*7490b008SAlexander Aring  * host->	ATUSB_RX_MODE		on		-	0
78*7490b008SAlexander Aring  * host->	ATUSB_TX		flags		ack_seq	#bytes
79*7490b008SAlexander Aring  */
80*7490b008SAlexander Aring 
81*7490b008SAlexander Aring #define ATUSB_REQ_FROM_DEV	(USB_TYPE_VENDOR | USB_DIR_IN)
82*7490b008SAlexander Aring #define ATUSB_REQ_TO_DEV	(USB_TYPE_VENDOR | USB_DIR_OUT)
83*7490b008SAlexander Aring 
84*7490b008SAlexander Aring #endif /* !_ATUSB_H */
85