VSF Documented
sdio.h
Go to the documentation of this file.
1/*****************************************************************************
2 * Copyright(C)2009-2022 by VSF Team *
3 * *
4 * Licensed under the Apache License, Version 2.0 (the "License"); *
5 * you may not use this file except in compliance with the License. *
6 * You may obtain a copy of the License at *
7 * *
8 * http://www.apache.org/licenses/LICENSE-2.0 *
9 * *
10 * Unless required by applicable law or agreed to in writing, software *
11 * distributed under the License is distributed on an "AS IS" BASIS, *
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
13 * See the License for the specific language governing permissions and *
14 * limitations under the License. *
15 * *
16 ****************************************************************************/
17
18#ifndef __HAL_DRIVER_${SERIES/SDIO_IP}_SDIO_H__
19#define __HAL_DRIVER_${SERIES/SDIO_IP}_SDIO_H__
20
21/*============================ INCLUDES ======================================*/
22
23#include "hal/vsf_hal_cfg.h"
24
25#if VSF_HAL_USE_SDIO == ENABLED
26
27// HW/IPCore
32// HW/IPCore end
33
34#include "../../__device.h"
35
36/*\note Refer to template/README.md for usage cases.
37 * For peripheral drivers, blackbox mode is recommended but not required, reimplementation part MUST be open.
38 * For IPCore drivers, class structure, MULTI_CLASS configuration, reimplementation and class APIs should be open to user.
39 * For emulated drivers, **** No reimplementation ****.
40 */
41
42/*\note Includes CAN ONLY be put here. */
43/*\note If current header is for a peripheral driver(hw driver), and inherit from an IPCore driver, include IPCore header here. */
44
45// IPCore
46#if defined(__VSF_HAL_${SDIO_IP}_SDIO_CLASS_IMPLEMENT)
47# define __VSF_CLASS_IMPLEMENT__
48#elif defined(__VSF_HAL_${SDIO_IP}_SDIO_CLASS_INHERIT__)
49# define __VSF_CLASS_INHERIT__
50#endif
51
52#include "utilities/ooc_class.h"
53// IPCore end
54
55#ifdef __cplusplus
56extern "C" {
57#endif
58
59/*============================ MACROS ========================================*/
60
61/*\note VSF_${SDIO_IP}_SDIO_CFG_MULTI_CLASS should be implemented for IP drives and open to user,
62 * while VSF_HW_SDIO_CFG_MULTI_CLASS should be in sdio.c.
63 */
64
65// IPCore
66#ifndef VSF_${SDIO_IP}_SDIO_CFG_MULTI_CLASS
67# define VSF_${SDIO_IP}_SDIO_CFG_MULTI_CLASS VSF_SDIO_CFG_MULTI_CLASS
68#endif
69// IPCore end
70
71// HW
72/*\note hw SDIO driver can reimplement following types:
73 * To enable reimplementation, please enable macro below:
74 * VSF_SDIO_CFG_REIMPLEMENT_TYPE_MODE for vsf_sdio_mode_t
75 * VSF_SDIO_CFG_REIMPLEMENT_TYPE_STATUS for vsf_sdio_status_t
76 * VSF_SDIO_CFG_REIMPLEMENT_TYPE_IRQ_MASK for vsf_sdio_irq_mask_t
77 * VSF_SDIO_CFG_REIMPLEMENT_TYPE_CTRL for vsf_sdio_ctrl_t
78 * VSF_SDIO_CFG_REIMPLEMENT_TYPE_CFG for vsf_sdio_cfg_t
79 * VSF_SDIO_CFG_REIMPLEMENT_TYPE_CAPABILITY for vsf_sdio_capability_t
80 * Reimplementation is used for optimization hw/IPCore drivers, reimplement the bit mask according to hw registers.
81 * *** DO NOT reimplement these in emulated drivers. ***
82 */
83
84#define VSF_SDIO_CFG_REIMPLEMENT_TYPE_MODE ENABLED
85#define VSF_SDIO_CFG_REIMPLEMENT_TYPE_STATUS ENABLED
86#define VSF_SDIO_CFG_REIMPLEMENT_TYPE_IRQ_MASK ENABLED
87#define VSF_SDIO_CFG_REIMPLEMENT_TYPE_CTRL ENABLED
88#define VSF_SDIO_CFG_REIMPLEMENT_TYPE_CFG ENABLED
89#define VSF_SDIO_CFG_REIMPLEMENT_TYPE_CAPABILITY ENABLED
90// HW end
91
92/*============================ MACROFIED FUNCTIONS ===========================*/
93/*============================ TYPES =========================================*/
94
95// IPCore
96vsf_class(vsf_${sdio_ip}_sdio_t) {
97#if VSF_${SDIO_IP}_CFG_MULTI_CLASS == ENABLED
98 public_member(
99 vsf_sdio_t vsf_sdio;
100 )
101#endif
102
103/*\note You can add more member in vsf_${sdio_ip}_sdio_t instance.
104 * For members accessible from child, put in protected_member.
105 * Else, put in private_member.
106 */
107
108 protected_member(
109 vsf_${sdio_ip}_sdio_reg_t *reg;
112};
113// IPCore end
114
115// HW/IPCore, not for emulated drivers
116#if VSF_SDIO_CFG_REIMPLEMENT_TYPE_MODE == ENABLED
117typedef enum vsf_sdio_mode_t {
118 VSF_SDIO_MODE_HOST = (0x1ul << 0),
119 VSF_SDIO_MODE_SLAVE = (0x0ul << 0),
120 VSF_SDIO_MODE_MASK = (0x1ul << 0),
122#endif
123
124#if VSF_SDIO_CFG_REIMPLEMENT_TYPE_REQOP == ENABLED
125typedef enum vsf_sdio_reqop_t {
126 SDIO_CMDOP_BYTE = (0ul << 0),
127 SDIO_CMDOP_STREAM = (1ul << 0),
130 SDIO_CMDOP_WRITE = (1ul << 2),
131 SDIO_CMDOP_READ = (0ul << 2),
133 __SDIO_CMDOP_RESP = (1ul << 4),
139#define SDIO_RESP_R1B (__SDIO_CMDOP_RESP | __SDIO_CMDOP_RESP_SHORT_CRC | SDIO_CMDOP_RESP_BUSY)
140#define SDIO_RESP_R2 (__SDIO_CMDOP_RESP | __SDIO_CMDOP_RESP_LONG_CRC)
141#define SDIO_RESP_R3 (__SDIO_CMDOP_RESP | __SDIO_CMDOP_RESP_SHORT)
142#define SDIO_RESP_R4 (__SDIO_CMDOP_RESP | __SDIO_CMDOP_RESP_SHORT)
143#define SDIO_RESP_R5 (__SDIO_CMDOP_RESP | __SDIO_CMDOP_RESP_SHORT_CRC)
144#define SDIO_RESP_R6 (__SDIO_CMDOP_RESP | __SDIO_CMDOP_RESP_SHORT_CRC)
145#define SDIO_RESP_R7 (__SDIO_CMDOP_RESP | __SDIO_CMDOP_RESP_SHORT_CRC)
146 SDIO_CMDOP_CLKHOLD = (1ul << 7),
149#endif
150
151#if VSF_SDIO_CFG_REIMPLEMENT_TYPE_IRQ_MASK == ENABLED
153 // TODO: add irq mask for stream mode
156 SDIO_IRQ_MASK_HOST_DATA_ABORT = (0x1ul << 2), // aborted by CMD12
161#endif
162
163#if VSF_SDIO_CFG_REIMPLEMENT_TYPE_REQSTS == ENABLED
164typedef enum vsf_sdio_reqsts_t {
169 SDIO_REQSTS_DATA_BUSY = (0x1ul << 3),
170 SDIO_REQSTS_BUSY = (0x1ul << 4),
175#endif
176
177#if VSF_SDIO_CFG_REIMPLEMENT_TYPE_STATUS == ENABLED
178typedef struct vsf_sdio_status_t {
179 union {
181 vsf_sdio_reqsts_t req_status;
183 };
185#endif
186
187#if VSF_SDIO_CFG_REIMPLEMENT_TYPE_CFG == ENABLED
188typedef struct vsf_sdio_t vsf_sdio_t;
189typedef void vsf_sdio_isr_handler_t(void *target_ptr,
190 vsf_sdio_t *sdio_ptr,
193 uint32_t resp[4]);
194typedef struct vsf_sdio_isr_t {
196
197 void *target_ptr;
198
200
202typedef struct vsf_sdio_cfg_t {
204
206
208#endif
209
210#if VSF_SDIO_CFG_REIMPLEMENT_TYPE_CAPABILITY == ENABLED
211typedef struct vsf_sdio_capability_t {
212#if VSF_SDIO_CFG_INHERIT_HAL_CAPABILITY == ENABLED
214#endif
215 enum {
216 SDIO_CAP_BUS_WIDTH_1 = (0x1ul << 0),
217 SDIO_CAP_BUS_WIDTH_4 = (0x1ul << 1),
218 SDIO_CAP_BUS_WIDTH_8 = (0x1ul << 2),
219 } bus_width;
223 bool support_ddr;
225#endif
226// HW/IPCore end
227
228/*============================ INCLUDES ======================================*/
229
230// IPCore
231/*\note Extern APIs for ip core diriver.
232 * There is no requirement about how APIs of IPCore drivers should be implemented.
233 * Just consider the simplicity for actual peripheral drivers.
234 */
235// IPCore end
236
237#ifdef __cplusplus
238}
239#endif
240
241// IPCore
242#undef __VSF_HAL_${SDIO_IP}_SDIO_CLASS_IMPLEMENT
243#undef __VSF_HAL_${SDIO_IP}_SDIO_CLASS_INHERIT__
244// IPCore end
245
246#endif // VSF_HAL_USE_SDIO
247#endif // __HAL_DRIVER_${SERIES/SDIO_IP}_SDIO_H__
248/* EOF */
vsf_sdio_reqop_t
Definition sdio.h:38
@ SDIO_CMDOP_READ
Definition sdio.h:43
@ SDIO_CMDOP_SINGLE_BLOCK
Definition sdio.h:39
@ __SDIO_CMDOP_RESP
Definition sdio.h:46
@ SDIO_CMDOP_TRANS_STOP
Definition sdio.h:53
@ __SDIO_CMDOP_RESP_LONG_CRC
Definition sdio.h:49
@ SDIO_CMDOP_WRITE
Definition sdio.h:44
@ __SDIO_CMDOP_RESP_SHORT
Definition sdio.h:47
@ SDIO_CMDOP_CLKHOLD
Definition sdio.h:52
@ SDIO_CMDOP_MULTI_BLOCK
Definition sdio.h:40
@ __SDIO_CMDOP_RESP_SHORT_CRC
Definition sdio.h:48
vsf_sdio_irq_mask_t
Definition sdio.h:78
@ SDIO_IRQ_MASK_HOST_DATA_DONE
Definition sdio.h:80
@ SDIO_IRQ_MASK_HOST_RESP_DONE
Definition sdio.h:79
@ SDIO_IRQ_MASK_HOST_ALL
Definition sdio.h:81
#define SDIO_RESP_NONE
Definition sdio.h:67
#define SDIO_RESP_R1
Definition sdio.h:68
vsf_sdio_reqsts_t
Definition sdio.h:85
@ SDIO_REQSTS_ERR_MASK
Definition sdio.h:92
@ SDIO_REQSTS_BUSY
Definition sdio.h:91
@ SDIO_REQSTS_DATA_BUSY
Definition sdio.h:90
@ SDIO_REQSTS_DONE
Definition sdio.h:86
@ SDIO_REQSTS_ERR_RESP_CRC
Definition sdio.h:88
@ SDIO_REQSTS_ERR_RESP_NONE
Definition sdio.h:87
@ SDIO_REQSTS_ERR_DATA_CRC
Definition sdio.h:89
@ SDIO_CMDOP_RESP_BUSY
Definition sdio.h:75
@ SDIO_CMDOP_BYTE
Definition sdio.h:47
@ SDIO_CMDOP_STREAM
Definition sdio.h:48
@ SDIO_IRQ_MASK_HOST_DATA_ABORT
Definition sdio.h:84
Definition adc.h:94
vsf_arch_prio_t
Definition cortex_a_generic.h:88
#define vsf_class(__name)
Definition ooc_class.h:48
const i_spi_t vsf_spi_irq_mask_t irq_mask
Definition spi_interface.h:38
unsigned short uint16_t
Definition stdint.h:7
unsigned uint32_t
Definition stdint.h:9
Definition vsf_template_hal_driver.h:203
Definition vsf_template_hal_driver.h:196
Definition vsf_template_sdio.h:741
bus_width
Definition vsf_template_sdio.h:749
bool support_ddr
Definition vsf_template_sdio.h:754
uint16_t data_size_alignment
Definition vsf_template_sdio.h:753
uint32_t max_freq_hz
Definition vsf_template_sdio.h:750
uint16_t data_ptr_alignment
Definition vsf_template_sdio.h:752
inherit(vsf_peripheral_capability_t) enum
Definition sdio.h:213
sdio configuration
Definition vsf_template_sdio.h:823
vsf_sdio_isr_t isr
Definition vsf_template_sdio.h:826
vsf_sdio_mode_t mode
Definition vsf_template_sdio.h:824
sdio interrupt configuration
Definition vsf_template_sdio.h:807
vsf_sdio_isr_handler_t * handler_fn
Definition vsf_template_sdio.h:808
void * target_ptr
Definition vsf_template_sdio.h:810
vsf_arch_prio_t prio
Definition vsf_template_sdio.h:812
Definition vsf_template_sdio.h:732
vsf_sdio_irq_mask_t irq_status
Definition vsf_template_sdio.h:736
Definition vsf_template_sdio.h:841
void vsf_sdio_isr_handler_t(void *target_ptr, vsf_sdio_t *sdio_ptr, vsf_sdio_irq_mask_t irq_mask, vsf_sdio_reqsts_t status, uint32_t resp[4])
Definition sdio.h:189
vsf_sdio_mode_t
Definition sdio.h:117
@ VSF_SDIO_MODE_HOST
Definition sdio.h:118
@ VSF_SDIO_MODE_SLAVE
Definition sdio.h:119
@ VSF_SDIO_MODE_MASK
Definition sdio.h:120
class vsf_$ * reg
vsf_sdio_isr_t isr
Definition sdio.h:111
vsf_sdio_mode_t
Definition vsf_template_sdio.h:644
uint8_t status
Definition vsf_tgui.h:144
Generated from commit: vsfteam/vsf@2b286be