Zephyr API Documentation  3.5.0
A Scalable Open Source RTOS
3.5.0
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
sd.h
Go to the documentation of this file.
1/*
2 * Copyright 2022 NXP
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
12#ifndef ZEPHYR_INCLUDE_SD_SD_H_
13#define ZEPHYR_INCLUDE_SD_SD_H_
14
15#include <zephyr/device.h>
16#include <zephyr/drivers/sdhc.h>
17#include <zephyr/kernel.h>
18
19#ifdef __cplusplus
20extern "C" {
21#endif
22
30};
31
40};
41
42
50struct sd_card {
51 const struct device *sdhc;
52 struct sdhc_io bus_io;
54 struct k_mutex lock;
58 unsigned int num_io: 3;
68 uint8_t card_buffer[CONFIG_SD_BUFFER_SIZE]
69 __aligned(CONFIG_SDHC_BUFFER_ALIGNMENT); /* Card internal buffer */
70};
71
84int sd_init(const struct device *sdhc_dev, struct sd_card *card);
85
93bool sd_is_card_present(const struct device *sdhc_dev);
94
95
96#ifdef __cplusplus
97}
98#endif
99
100#endif /* ZEPHYR_INCLUDE_SD_SD_H_ */
sd_voltage
SD voltage.
Definition: sdhc.h:144
Public kernel APIs.
card_status
card status.
Definition: sd.h:26
@ CARD_ERROR
card state is error
Definition: sd.h:28
@ CARD_INITIALIZED
card is in valid state
Definition: sd.h:29
@ CARD_UNINITIALIZED
card has not been initialized
Definition: sd.h:27
int sd_init(const struct device *sdhc_dev, struct sd_card *card)
Initialize an SD device.
bool sd_is_card_present(const struct device *sdhc_dev)
checks to see if card is present in the SD slot
card_type
card type.
Definition: sd.h:35
@ CARD_SDIO
SD I/O card.
Definition: sd.h:37
@ CARD_MMC
MMC memory card.
Definition: sd.h:39
@ CARD_SDMMC
SD memory card.
Definition: sd.h:36
@ CARD_COMBO
SD memory and I/O card.
Definition: sd.h:38
SD Host Controller public API header file.
__UINT32_TYPE__ uint32_t
Definition: stdint.h:90
__UINT8_TYPE__ uint8_t
Definition: stdint.h:88
__UINT16_TYPE__ uint16_t
Definition: stdint.h:89
Runtime device structure (in ROM) per driver instance.
Definition: device.h:381
Mutex Structure.
Definition: kernel.h:2911
SD card structure.
Definition: sd.h:50
enum card_status status
Card status.
Definition: sd.h:64
struct sd_switch_caps switch_caps
SD switch capabilities.
Definition: sd.h:57
unsigned int num_io
I/O function count.
Definition: sd.h:58
uint16_t relative_addr
Card relative address.
Definition: sd.h:59
uint8_t bus_width
Desired bus width.
Definition: sd.h:67
uint16_t block_size
SD block size.
Definition: sd.h:61
uint8_t sd_version
SD specification version.
Definition: sd.h:62
enum card_type type
Card type.
Definition: sd.h:65
uint8_t card_buffer[CONFIG_SD_BUFFER_SIZE]
Definition: sd.h:69
uint32_t ocr
Raw card OCR content.
Definition: sd.h:56
struct sdhc_io bus_io
Current bus I/O props for SDHC.
Definition: sd.h:52
uint8_t card_speed
Card timing mode.
Definition: sd.h:63
struct sdhc_host_props host_props
SDHC host properties.
Definition: sd.h:55
struct k_mutex lock
card mutex
Definition: sd.h:54
uint32_t block_count
Number of blocks in SD card.
Definition: sd.h:60
uint16_t flags
Card flags.
Definition: sd.h:66
enum sd_voltage card_voltage
Card signal voltage.
Definition: sd.h:53
const struct device * sdhc
SD host controller for card.
Definition: sd.h:51
SD switch capabilities.
Definition: sd_spec.h:485
SD host controller properties.
Definition: sdhc.h:223
SD host controller I/O control structure.
Definition: sdhc.h:208