• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * SD-SPI Protocol Standard
3  *
4  * Copyright (C) 1999-2017, Broadcom Corporation
5  *
6  *      Unless you and Broadcom execute a separate written software license
7  * agreement governing use of this software, this software is licensed to you
8  * under the terms of the GNU General Public License version 2 (the "GPL"),
9  * available at http://www.broadcom.com/licenses/GPLv2.php, with the
10  * following added to such license:
11  *
12  *      As a special exception, the copyright holders of this software give you
13  * permission to link this software with independent modules, and to copy and
14  * distribute the resulting executable under terms of your choice, provided that
15  * you also meet, for each linked independent module, the terms and conditions of
16  * the license of that module.  An independent module is a module which is not
17  * derived from this software.  The special exception does not apply to any
18  * modifications of the software.
19  *
20  *      Notwithstanding the above, under no circumstances may you combine this
21  * software in any way with any other Broadcom software provided under a license
22  * other than the GPL, without Broadcom's express prior written consent.
23  *
24  *
25  * <<Broadcom-WL-IPTag/Open:>>
26  *
27  * $Id: sdspi.h 700076 2017-05-17 14:42:22Z $
28  */
29 #ifndef	_SD_SPI_H
30 #define	_SD_SPI_H
31 
32 #define SPI_START_M		BITFIELD_MASK(1)	/* Bit [31] 	- Start Bit */
33 #define SPI_START_S		31
34 #define SPI_DIR_M		BITFIELD_MASK(1)	/* Bit [30] 	- Direction */
35 #define SPI_DIR_S		30
36 #define SPI_CMD_INDEX_M		BITFIELD_MASK(6)	/* Bits [29:24] - Command number */
37 #define SPI_CMD_INDEX_S		24
38 #define SPI_RW_M		BITFIELD_MASK(1)	/* Bit [23] 	- Read=0, Write=1 */
39 #define SPI_RW_S		23
40 #define SPI_FUNC_M		BITFIELD_MASK(3)	/* Bits [22:20]	- Function Number */
41 #define SPI_FUNC_S		20
42 #define SPI_RAW_M		BITFIELD_MASK(1)	/* Bit [19] 	- Read After Wr */
43 #define SPI_RAW_S		19
44 #define SPI_STUFF_M		BITFIELD_MASK(1)	/* Bit [18] 	- Stuff bit */
45 #define SPI_STUFF_S		18
46 #define SPI_BLKMODE_M		BITFIELD_MASK(1)	/* Bit [19] 	- Blockmode 1=blk */
47 #define SPI_BLKMODE_S		19
48 #define SPI_OPCODE_M		BITFIELD_MASK(1)	/* Bit [18] 	- OP Code */
49 #define SPI_OPCODE_S		18
50 #define SPI_ADDR_M		BITFIELD_MASK(17)	/* Bits [17:1] 	- Address */
51 #define SPI_ADDR_S		1
52 #define SPI_STUFF0_M		BITFIELD_MASK(1)	/* Bit [0] 	- Stuff bit */
53 #define SPI_STUFF0_S		0
54 
55 #define SPI_RSP_START_M		BITFIELD_MASK(1)	/* Bit [7] 	- Start Bit (always 0) */
56 #define SPI_RSP_START_S		7
57 #define SPI_RSP_PARAM_ERR_M	BITFIELD_MASK(1)	/* Bit [6] 	- Parameter Error */
58 #define SPI_RSP_PARAM_ERR_S	6
59 #define SPI_RSP_RFU5_M		BITFIELD_MASK(1)	/* Bit [5] 	- RFU (Always 0) */
60 #define SPI_RSP_RFU5_S		5
61 #define SPI_RSP_FUNC_ERR_M	BITFIELD_MASK(1)	/* Bit [4] 	- Function number error */
62 #define SPI_RSP_FUNC_ERR_S	4
63 #define SPI_RSP_CRC_ERR_M	BITFIELD_MASK(1)	/* Bit [3] 	- COM CRC Error */
64 #define SPI_RSP_CRC_ERR_S	3
65 #define SPI_RSP_ILL_CMD_M	BITFIELD_MASK(1)	/* Bit [2] 	- Illegal Command error */
66 #define SPI_RSP_ILL_CMD_S	2
67 #define SPI_RSP_RFU1_M		BITFIELD_MASK(1)	/* Bit [1] 	- RFU (Always 0) */
68 #define SPI_RSP_RFU1_S		1
69 #define SPI_RSP_IDLE_M		BITFIELD_MASK(1)	/* Bit [0] 	- In idle state */
70 #define SPI_RSP_IDLE_S		0
71 
72 /* SD-SPI Protocol Definitions */
73 #define SDSPI_COMMAND_LEN	6	/* Number of bytes in an SD command */
74 #define SDSPI_START_BLOCK	0xFE	/* SD Start Block Token */
75 #define SDSPI_IDLE_PAD		0xFF	/* SD-SPI idle value for MOSI */
76 #define SDSPI_START_BIT_MASK	0x80
77 
78 #endif /* _SD_SPI_H */
79