设计说明
源码说明
源代码位于 bsp/artinchip/
:
bsp/artinchip/drv/sdmc/drv_sdmc.c,SDMC Driver 层实现
bsp/artinchip/hal/sdmc/hal_sdmc.c,SDMC HAL 层实现
bsp/artinchip/include/hal/hal_sdmc.h,SDMC HAL 层接口头文件
此外,提供了一个 Baremetal 设计实例供参考,源代码位于:
bsp/artinchip/drv_bare/sdmc/sdmc.c,Baremetal的SDMC Driver 层实现
bsp/artinchip/drv_bare/sdmc/mmc.c,Baremetal的SDMC Driver 层使用实例
bsp/artinchip/drv_bare/sdmc/sdmc.h,Baremetal的SDMC Driver 层头文件
bsp/artinchip/include/drv_bare/mmc.h,Baremetal的SDMC Driver 层使用实例头文件
packages/third-party/dfs,Baremetal的文件系统实现
模块架构
SDMC 驱动 Driver 层采用 RT-Thread 的SDIO设备驱动框架,如果只使用HAL层也可以支持 Baremetal 方式的应用场景。
其中:
DFS层:Baremetal文件系统层,提供接口给Baremetal APP读写Baremetal SDMC文件。
Baremetal MMC层:向上对接DFS,提供读写接口;向下对接Baremetal SDMC driver层。
Baremetal SDMC Driver层:提供SDMC驱动初始化接口,方便Baremetal MMC层的访问。
SDMC Driver层:负责对接 SDIO设备框架,注册成块设备,方便应用层的访问。
SDMC HAL层:封装了寄存器级别的操作,对Driver层屏蔽硬件级别的访问。
关键流程设计
RT-Thread初始化流程
SDMC 控制器驱动的初始化接口通过 INIT_DEVICE_EXPORT(drv_sdmc_init)
完成注册。 其中,主要步骤如下:
分配 host 管理结构(包括 rt_mmcsd_host 和 aic_sdmc)
初始化模块的clk
注册中断
初始化控制器
通知 mmcsd 监测线程(mmcsd_change)
Baremetal初始化流程
SDMC 控制器驱动通过mmc_init()
完成初始化。 其中,主要步骤如下:
分配host管理结构和dev设备信息结构(aic_sdmc 和 aic_sdmc_dev)
初始化模块的clk
注册中断
初始化控制器
数据结构设计
struct aic_sdmc_host
属于 HAL 层接口,定义了 SDMC控制器 管理信息:
struct aic_sdmc_host {
volatile void *base;
u32 is_sdio;
u32 fifoth_val;
#ifdef AIC_SDMC_IRQ_MODE
aicos_sem_t complete;
#endif
};
2
3
4
5
6
7
8
struct aic_sdmc_idma_desc
属于 HAL 层接口,记录了 SDMC控制器内部DMA访问的描述符:
struct aic_sdmc_idma_desc {
u32 flags;
u32 cnt;
u32 addr;
u32 next_addr;
} __aligned(8);
2
3
4
5
6
struct aic_sdmc
RT-Thread
属于 Driver 层的内部接口,用于记录 SDMC 控制器的管理信息:
struct aic_sdmc {
struct rt_mmcsd_host *rthost;
struct rt_mmcsd_req *req;
struct rt_mmcsd_cmd *cmd;
struct aic_sdmc_host host;
rt_uint32_t *buf;
u32 clk;
u32 irq;
u32 index;
u32 cid[4];
unsigned int quirks;
unsigned int caps;
unsigned int version;
unsigned int clock;
unsigned int sclk_rate;
unsigned int div;
int buswidth;
int ddr_mode;
/* use fifo mode to read and write data */
int fifo_mode;
struct aic_sdmc_pdata *pdata;
u8 is_enable;
};
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
Baremetal
属于 Baremetal Driver 层的内部接口,用于记录 SDMC 控制器的管理信息:
struct aic_sdmc {
struct aic_sdmc_dev *dev;
struct aic_sdmc_cmd *cmd;
struct aic_sdmc_data *data;
struct aic_sdmc_host host;
u32 *buf;
u32 clk;
u32 irq;
u32 index;
unsigned int quirks;
unsigned int caps;
unsigned int version;
unsigned int clock;
unsigned int sclk_rate;
unsigned int div;
int buswidth;
int ddr_mode;
/* use fifo mode to read and write data */
int fifo_mode;
struct aic_sdmc_pdata *pdata;
};
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
Driver 层接口设计
Baremetal Driver 参考 Driver层设计,去除了 RT-Thread 所需的结构信息。
以下接口皆为 SDIO设备驱动框架所需要的标准接口,目前SDMC驱动仅实现了其中的 request 和 set_iocfg 接口。
struct rt_mmcsd_host_ops {
void (*request)(struct rt_mmcsd_host *host, struct rt_mmcsd_req *req);
void (*set_iocfg)(struct rt_mmcsd_host *host, struct rt_mmcsd_io_cfg *io_cfg);
rt_int32_t (*get_card_status)(struct rt_mmcsd_host *host);
void (*enable_sdio_irq)(struct rt_mmcsd_host *host, rt_int32_t en);
};
2
3
4
5
6
aic_sdmc_request
RT-Thread
Baremetal
aic_sdmc_set_iocfg
RT-Thread
Baremetal
HAL 层接口设计
HAL 层的函数接口声明存放在 hal_sdmc.h 中,主要接口有:
void hal_sdmc_idma_update_intstat(struct aic_sdmc_host *host);
int hal_sdmc_idma_start(struct aic_sdmc_host *host, u32 size, u32 read,
u32 *buf, struct bounce_buffer *bbstate);
int hal_sdmc_idma_stop(struct aic_sdmc_host *host,
struct bounce_buffer *bbstate, u32 read);
void hal_sdmc_idma_disable(struct aic_sdmc_host *host);
u8 hal_sdmc_get_idma_status(struct aic_sdmc_host *host);
void hal_sdmc_idma_prepare(struct aic_sdmc_host *host,
u32 blksize, u32 blks,
struct aic_sdmc_idma_desc *cur_idma,
void *bounce_buffer);
int hal_sdmc_data_rx(struct aic_sdmc_host *host, u32 *buf, u32 size);
int hal_sdmc_data_tx(struct aic_sdmc_host *host, u32 *buf, u32 size);
u32 hal_sdmc_int_stat(struct aic_sdmc_host *host);
void hal_sdmc_int_clr(struct aic_sdmc_host *host, u32 mask);
int hal_sdmc_is_busy(struct aic_sdmc_host *host);
void hal_sdmc_set_blk(struct aic_sdmc_host *host, u32 blksize, u32 blks);
void hal_sdmc_set_arg(struct aic_sdmc_host *host, u32 arg);
void hal_sdmc_set_cmd(struct aic_sdmc_host *host, u32 cmd);
u32 hal_sdmc_wait_cmd_started(struct aic_sdmc_host *host);
void hal_sdmc_get_rsp(struct aic_sdmc_host *host, u32 *buf, u32 all);
void aic_sdmc_set_ext_clk_mux(struct aic_sdmc_host *host, u32 mux);
void hal_sdmc_set_phase(struct aic_sdmc_host *host, u32 drv, u32 smp);
void hal_sdmc_set_buswidth(struct aic_sdmc_host *host, u32 buswidth);
void hal_sdmc_set_ddrmode(struct aic_sdmc_host *host, u32 ddr);
void hal_sdmc_clk_disable(struct aic_sdmc_host *host);
void hal_sdmc_clk_enable(struct aic_sdmc_host *host);
void hal_sdmc_sdio_irq_enable(struct aic_sdmc_host *host, u32 en);
void hal_sdmc_set_div(struct aic_sdmc_host *host, u32 div);
void hal_sdmc_fifo_init(struct aic_sdmc_host *host, u32 *thd);
int hal_sdmc_reset(struct aic_sdmc_host *host, u32 value);
void hal_sdmc_init(struct aic_sdmc_host *host);
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36