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_NATIONS_N32H76X_N32H78X_SDIO_H__
19#define __HAL_DRIVER_NATIONS_N32H76X_N32H78X_SDIO_H__
20
21#ifdef __VSF_TEMPLATE_SDIO_H__
22# error vsf_template_sdio.h CAN NOT be included before this header file
23#endif
24
25/*============================ INCLUDES ======================================*/
26
27#include "hal/vsf_hal_cfg.h"
28
29#if VSF_HAL_USE_SDIO == ENABLED
30
31// HW/IPCore
36// HW/IPCore end
37
38/*\note Refer to template/README.md for usage cases.
39 * For peripheral drivers, blackbox mode is recommended but not required, reimplementation part MUST be open.
40 * For IPCore drivers, class structure, MULTI_CLASS configuration, reimplementation and class APIs should be open to user.
41 * For emulated drivers, **** No reimplementation ****.
42 */
43
44/*\note Includes CAN ONLY be put here. */
45/*\note If current header is for a peripheral driver(hw driver), and inherit from an IPCore driver, include IPCore header here. */
46
47#ifdef __cplusplus
48extern "C" {
49#endif
50
51/*============================ MACROS ========================================*/
52
53// HW
54/*\note hw SDIO driver can reimplement following types:
55 * To enable reimplementation, please enable macro below:
56 * VSF_SDIO_CFG_REIMPLEMENT_TYPE_MODE for vsf_sdio_mode_t
57 * VSF_SDIO_CFG_REIMPLEMENT_TYPE_STATUS for vsf_sdio_status_t
58 * VSF_SDIO_CFG_REIMPLEMENT_TYPE_IRQ_MASK for vsf_sdio_irq_mask_t
59 * VSF_SDIO_CFG_REIMPLEMENT_TYPE_CTRL for vsf_sdio_ctrl_t
60 * VSF_SDIO_CFG_REIMPLEMENT_TYPE_CFG for vsf_sdio_cfg_t
61 * VSF_SDIO_CFG_REIMPLEMENT_TYPE_CAPABILITY for vsf_sdio_capability_t
62 * Reimplementation is used for optimization hw/IPCore drivers, reimplement the bit mask according to hw registers.
63 * *** DO NOT reimplement these in emulated drivers. ***
64 */
65
66#define VSF_SDIO_CFG_REIMPLEMENT_TYPE_MODE ENABLED
67#define VSF_SDIO_CFG_REIMPLEMENT_TYPE_STATUS ENABLED
68#define VSF_SDIO_CFG_REIMPLEMENT_TYPE_REQSTS ENABLED
69#define VSF_SDIO_CFG_REIMPLEMENT_TYPE_IRQ_MASK ENABLED
70#define VSF_SDIO_CFG_REIMPLEMENT_TYPE_CTRL ENABLED
71#define VSF_SDIO_CFG_REIMPLEMENT_TYPE_CFG ENABLED
72#define VSF_SDIO_CFG_REIMPLEMENT_TYPE_CAPABILITY ENABLED
73// HW end
74
75/*============================ MACROFIED FUNCTIONS ===========================*/
76/*============================ TYPES =========================================*/
77
78// HW/IPCore, not for emulated drivers
79#if VSF_SDIO_CFG_REIMPLEMENT_TYPE_MODE == ENABLED
80typedef enum vsf_sdio_mode_t {
81 SDIO_MODE_HOST = (0x1ul << 0),
82 SDIO_MODE_SLAVE = (0x0ul << 0),
83 SDIO_MODE_MASK = (0x1ul << 0),
85#endif
86
87#if VSF_SDIO_CFG_REIMPLEMENT_TYPE_REQOP == ENABLED
88typedef enum vsf_sdio_reqop_t {
89 SDIO_CMDOP_BYTE = (0ul << 0),
90 SDIO_CMDOP_STREAM = (1ul << 0),
93 SDIO_CMDOP_WRITE = (1ul << 2),
94 SDIO_CMDOP_READ = (0ul << 2),
96 __SDIO_CMDOP_RESP = (1ul << 4),
102#define SDIO_RESP_R1B (__SDIO_CMDOP_RESP | __SDIO_CMDOP_RESP_SHORT_CRC | SDIO_CMDOP_RESP_BUSY)
103#define SDIO_RESP_R2 (__SDIO_CMDOP_RESP | __SDIO_CMDOP_RESP_LONG_CRC)
104#define SDIO_RESP_R3 (__SDIO_CMDOP_RESP | __SDIO_CMDOP_RESP_SHORT)
105#define SDIO_RESP_R4 (__SDIO_CMDOP_RESP | __SDIO_CMDOP_RESP_SHORT)
106#define SDIO_RESP_R5 (__SDIO_CMDOP_RESP | __SDIO_CMDOP_RESP_SHORT_CRC)
107#define SDIO_RESP_R6 (__SDIO_CMDOP_RESP | __SDIO_CMDOP_RESP_SHORT_CRC)
108#define SDIO_RESP_R7 (__SDIO_CMDOP_RESP | __SDIO_CMDOP_RESP_SHORT_CRC)
109 SDIO_CMDOP_CLKHOLD = (1ul << 7),
112#endif
113
114#if VSF_SDIO_CFG_REIMPLEMENT_TYPE_IRQ_MASK == ENABLED
116 // TODO: add irq mask for stream mode
119 SDIO_IRQ_MASK_HOST_DATA_ABORT = (0x1ul << 2), // aborted by CMD12
124#endif
125
126#if VSF_SDIO_CFG_REIMPLEMENT_TYPE_REQSTS == ENABLED
127typedef enum vsf_sdio_reqsts_t {
132 SDIO_REQSTS_DATA_BUSY = (0x1ul << 3),
133 SDIO_REQSTS_BUSY = (0x1ul << 4),
138#endif
139
140#if VSF_SDIO_CFG_REIMPLEMENT_TYPE_STATUS == ENABLED
141typedef struct vsf_sdio_status_t {
142 union {
144 vsf_sdio_reqsts_t req_status;
146 };
148#endif
149
150#if VSF_SDIO_CFG_REIMPLEMENT_TYPE_CFG == ENABLED
151typedef struct vsf_sdio_t vsf_sdio_t;
152typedef void vsf_sdio_isr_handler_t(void *target_ptr,
153 vsf_sdio_t *sdio_ptr,
156 uint32_t resp[4]);
157typedef struct vsf_sdio_isr_t {
159
160 void *target_ptr;
161
163
165typedef struct vsf_sdio_cfg_t {
167
169
171#endif
172
173#if VSF_SDIO_CFG_REIMPLEMENT_TYPE_CAPABILITY == ENABLED
174typedef struct vsf_sdio_capability_t {
175#if VSF_SDIO_CFG_INHERIT_HAL_CAPABILITY == ENABLED
177#endif
178 enum {
179 SDIO_CAP_BUS_WIDTH_1 = (0x1ul << 0),
180 SDIO_CAP_BUS_WIDTH_4 = (0x1ul << 1),
181 SDIO_CAP_BUS_WIDTH_8 = (0x1ul << 2),
182 } bus_width;
186 bool support_ddr;
188#endif
189// HW/IPCore end
190
191/*============================ INCLUDES ======================================*/
192
193#ifdef __cplusplus
194}
195#endif
196
197#endif // VSF_HAL_USE_SDIO
198#endif // __HAL_DRIVER_NATIONS_N32H76X_N32H78X_SDIO_H__
199/* 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_BYTE
Definition sdio.h:54
@ SDIO_CMDOP_STREAM
Definition sdio.h:55
@ 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:95
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:152
@ SDIO_IRQ_MASK_HOST_DATA_ABORT
Definition sdio.h:119
struct vsf_sdio_capability_t vsf_sdio_capability_t
vsf_sdio_mode_t
Definition sdio.h:80
@ SDIO_MODE_MASK
Definition sdio.h:83
@ SDIO_MODE_SLAVE
Definition sdio.h:82
@ SDIO_MODE_HOST
Definition sdio.h:81
struct vsf_sdio_isr_t vsf_sdio_isr_t
struct vsf_sdio_status_t vsf_sdio_status_t
struct vsf_sdio_cfg_t vsf_sdio_cfg_t
vsf_arch_prio_t
Definition cortex_a_generic.h:88
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:743
bus_width
Definition vsf_template_sdio.h:751
bool support_ddr
Definition vsf_template_sdio.h:756
uint16_t data_size_alignment
Definition vsf_template_sdio.h:755
uint32_t max_freq_hz
Definition vsf_template_sdio.h:752
uint16_t data_ptr_alignment
Definition vsf_template_sdio.h:754
inherit(vsf_peripheral_capability_t) enum
Definition sdio.h:176
sdio configuration
Definition vsf_template_sdio.h:826
vsf_sdio_isr_t isr
Definition vsf_template_sdio.h:829
vsf_sdio_mode_t mode
Definition vsf_template_sdio.h:827
sdio interrupt configuration
Definition vsf_template_sdio.h:810
vsf_sdio_isr_handler_t * handler_fn
Definition vsf_template_sdio.h:811
void * target_ptr
Definition vsf_template_sdio.h:813
vsf_arch_prio_t prio
Definition vsf_template_sdio.h:815
Definition vsf_template_sdio.h:733
vsf_sdio_irq_mask_t irq_status
Definition vsf_template_sdio.h:737
Definition vsf_template_sdio.h:844
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:188
vsf_sdio_mode_t
Definition vsf_template_sdio.h:645
uint8_t status
Definition vsf_tgui.h:144
Generated from commit: vsfteam/vsf@74aa6ce