PROTOCOLS
Device
Defined in fuchsia.hardware.sdio/sdio.fidl
DisableFn
Request
| Name | Type |
|---|
Response
| Name | Type |
|---|---|
result |
Device_DisableFn_Result
|
DisableFnIntr
Request
| Name | Type |
|---|
Response
| Name | Type |
|---|---|
result |
Device_DisableFnIntr_Result
|
DoRwByte
Request
| Name | Type |
|---|---|
write |
bool
|
addr |
uint32
|
write_byte |
uint8
|
Response
| Name | Type |
|---|---|
result |
Device_DoRwByte_Result
|
DoRwTxn
Request
| Name | Type |
|---|---|
txn |
SdioRwTxn
|
Response
| Name | Type |
|---|---|
result |
Device_DoRwTxn_Result
|
DoVendorControlRwByte
Reads or writes to a vendor CCCR register. addr must be in [0xF0, 0xFF].
Request
| Name | Type |
|---|---|
write |
bool
|
addr |
uint8
|
write_byte |
uint8
|
Response
| Name | Type |
|---|---|
result |
Device_DoVendorControlRwByte_Result
|
EnableFn
Request
| Name | Type |
|---|
Response
| Name | Type |
|---|---|
result |
Device_EnableFn_Result
|
EnableFnIntr
Request
| Name | Type |
|---|
Response
| Name | Type |
|---|---|
result |
Device_EnableFnIntr_Result
|
GetBlockSize
Request
| Name | Type |
|---|
Response
| Name | Type |
|---|---|
result |
Device_GetBlockSize_Result
|
GetDevHwInfo
Request
| Name | Type |
|---|
Response
| Name | Type |
|---|---|
result |
Device_GetDevHwInfo_Result
|
GetInBandIntr
Request
| Name | Type |
|---|
Response
| Name | Type |
|---|---|
result |
Device_GetInBandIntr_Result
|
IntrPending
Returns true if an interrupt is pending for function fn_idx, false otherwise.
Request
| Name | Type |
|---|
Response
| Name | Type |
|---|---|
result |
Device_IntrPending_Result
|
IoAbort
The following functions access the card common control registers (CCCR) on function 0. Aborts an I/O operation occurring on the specified function.
Request
| Name | Type |
|---|
Response
| Name | Type |
|---|---|
result |
Device_IoAbort_Result
|
UpdateBlockSize
Request
| Name | Type |
|---|---|
blk_sz |
uint16
|
deflt |
bool
|
Response
| Name | Type |
|---|---|
result |
Device_UpdateBlockSize_Result
|
Sdio
Defined in fuchsia.hardware.sdio/sdio.fidl
DisableFn
Request
| Name | Type |
|---|
Response
| Name | Type |
|---|---|
s |
zx/status
|
DisableFnIntr
Request
| Name | Type |
|---|
Response
| Name | Type |
|---|---|
s |
zx/status
|
DoRwByte
Request
| Name | Type |
|---|---|
write |
bool
|
addr |
uint32
|
write_byte |
uint8
|
Response
| Name | Type |
|---|---|
s |
zx/status
|
read_byte |
uint8
|
DoRwTxn
Request
| Name | Type |
|---|---|
txn |
SdioRwTxn
|
Response
| Name | Type |
|---|---|
s |
zx/status
|
DoRwTxnNew
Clients are responsible for performing the following cache operations:
After read requests:
- Call zx_cache_flush with ZX_CACHE_FLUSH_DATA | ZX_CACHE_FLUSH_INVALIDATE on buffers that have been mapped by the client.
- Call zx_vmo_op_range with ZX_VMO_OP_CACHE_CLEAN_INVALIDATE on all other buffers.
Note that writing to any portion of a buffer before DoRwTxnNew has returned can corrupt the received data.
Before write requests:
- Call zx_cache_flush with ZX_CACHE_FLUSH_DATA on buffers that have been mapped by the client.
- Call zx_vmo_op_range with ZX_VMO_OP_CACHE_CLEAN on all other buffers.
Request
| Name | Type |
|---|---|
txn |
SdioRwTxnNew
|
Response
| Name | Type |
|---|---|
status |
zx/status
|
DoVendorControlRwByte
Reads or writes to a vendor CCCR register. addr must be in [0xF0, 0xFF].
Request
| Name | Type |
|---|---|
write |
bool
|
addr |
uint8
|
write_byte |
uint8
|
Response
| Name | Type |
|---|---|
s |
zx/status
|
read_byte |
uint8
|
EnableFn
Request
| Name | Type |
|---|
Response
| Name | Type |
|---|---|
s |
zx/status
|
EnableFnIntr
Request
| Name | Type |
|---|
Response
| Name | Type |
|---|---|
s |
zx/status
|
GetBlockSize
Request
| Name | Type |
|---|
Response
| Name | Type |
|---|---|
s |
zx/status
|
cur_blk_size |
uint16
|
GetDevHwInfo
Request
| Name | Type |
|---|
Response
| Name | Type |
|---|---|
s |
zx/status
|
hw_info |
SdioHwInfo
|
GetInBandIntr
Request
| Name | Type |
|---|
Response
| Name | Type |
|---|---|
s |
zx/status
|
irq |
handle<interrupt>
|
IntrPending
Returns true if an interrupt is pending for function fn_idx, false otherwise.
Request
| Name | Type |
|---|
Response
| Name | Type |
|---|---|
s |
zx/status
|
pending |
bool
|
IoAbort
The following functions access the card common control registers (CCCR) on function 0. Aborts an I/O operation occurring on the specified function.
Request
| Name | Type |
|---|
Response
| Name | Type |
|---|---|
s |
zx/status
|
RegisterVmo
Request
| Name | Type |
|---|---|
vmo_id |
uint32
|
vmo |
handle<vmo>
|
offset |
uint64
|
size |
uint64
|
vmo_rights |
uint32
|
Response
| Name | Type |
|---|---|
status |
zx/status
|
RunDiagnostics
Runs tests and logs the results in order to diagnose issues with the bus. Clients should call this before shutting down due to unrecoverable errors. This method may block for some time to send commands to the card, so it should be the last call made by the client. Note: SDIO devices may have different drivers bound to different functions. Clients must not call RunDiagnostics in these cases, since doing so could interfere with other clients. TODO(fxbug.dev/64166): Remove this when the SDIO issues have been investigated.
Request
| Name | Type |
|---|
UnregisterVmo
Request
| Name | Type |
|---|---|
vmo_id |
uint32
|
Response
| Name | Type |
|---|---|
status |
zx/status
|
vmo |
handle<vmo>
|
UpdateBlockSize
Request
| Name | Type |
|---|---|
blk_sz |
uint16
|
deflt |
bool
|
Response
| Name | Type |
|---|---|
s |
zx/status
|
STRUCTS
Device_DisableFnIntr_Response
Defined in fuchsia.hardware.sdio/sdio.fidl
| Name | Type | Description | Default |
|---|
Device_DisableFn_Response
Defined in fuchsia.hardware.sdio/sdio.fidl
| Name | Type | Description | Default |
|---|
Device_DoRwByte_Response
Defined in fuchsia.hardware.sdio/sdio.fidl
| Name | Type | Description | Default |
|---|---|---|---|
read_byte |
uint8
|
No default |
Device_DoRwTxn_Response resource
Defined in fuchsia.hardware.sdio/sdio.fidl
| Name | Type | Description | Default |
|---|---|---|---|
txn |
SdioRwTxn
|
No default |
Device_DoVendorControlRwByte_Response
Defined in fuchsia.hardware.sdio/sdio.fidl
| Name | Type | Description | Default |
|---|---|---|---|
read_byte |
uint8
|
No default |
Device_EnableFnIntr_Response
Defined in fuchsia.hardware.sdio/sdio.fidl
| Name | Type | Description | Default |
|---|
Device_EnableFn_Response
Defined in fuchsia.hardware.sdio/sdio.fidl
| Name | Type | Description | Default |
|---|
Device_GetBlockSize_Response
Defined in fuchsia.hardware.sdio/sdio.fidl
| Name | Type | Description | Default |
|---|---|---|---|
cur_blk_size |
uint16
|
No default |
Device_GetDevHwInfo_Response
Defined in fuchsia.hardware.sdio/sdio.fidl
| Name | Type | Description | Default |
|---|---|---|---|
hw_info |
SdioHwInfo
|
No default |
Device_GetInBandIntr_Response resource
Defined in fuchsia.hardware.sdio/sdio.fidl
| Name | Type | Description | Default |
|---|---|---|---|
irq |
handle<interrupt>
|
No default |
Device_IntrPending_Response
Defined in fuchsia.hardware.sdio/sdio.fidl
| Name | Type | Description | Default |
|---|---|---|---|
pending |
bool
|
No default |
Device_IoAbort_Response
Defined in fuchsia.hardware.sdio/sdio.fidl
| Name | Type | Description | Default |
|---|
Device_UpdateBlockSize_Response
Defined in fuchsia.hardware.sdio/sdio.fidl
| Name | Type | Description | Default |
|---|
SdioDeviceHwInfo
Defined in fuchsia.hardware.sdio/sdio.fidl
| Name | Type | Description | Default |
|---|---|---|---|
num_funcs |
uint32
|
number of sdio funcs including func 0 |
No default |
sdio_vsn |
uint32
|
No default | |
cccr_vsn |
uint32
|
No default | |
caps |
uint32
|
No default |
SdioDeviceHwInfo
Defined in fuchsia.hardware.sdio/sdio.fidl
| Name | Type | Description | Default |
|---|---|---|---|
num_funcs |
uint32
|
number of sdio funcs including func 0 |
No default |
sdio_vsn |
uint32
|
No default | |
cccr_vsn |
uint32
|
No default | |
caps |
uint32
|
No default |
SdioFuncHwInfo
Defined in fuchsia.hardware.sdio/sdio.fidl
| Name | Type | Description | Default |
|---|---|---|---|
manufacturer_id |
uint32
|
No default | |
product_id |
uint32
|
No default | |
max_blk_size |
uint32
|
No default | |
max_tran_speed |
uint32
|
No default | |
fn_intf_code |
uint8
|
No default |
SdioFuncHwInfo
Defined in fuchsia.hardware.sdio/sdio.fidl
| Name | Type | Description | Default |
|---|---|---|---|
manufacturer_id |
uint32
|
No default | |
product_id |
uint32
|
No default | |
max_blk_size |
uint32
|
No default | |
max_tran_speed |
uint32
|
No default | |
fn_intf_code |
uint8
|
No default |
SdioHwInfo
Defined in fuchsia.hardware.sdio/sdio.fidl
| Name | Type | Description | Default |
|---|---|---|---|
dev_hw_info |
SdioDeviceHwInfo
|
No default | |
funcs_hw_info |
[8]
|
No default | |
host_max_transfer_size |
uint32
|
No default |
SdioHwInfo
Defined in fuchsia.hardware.sdio/sdio.fidl
| Name | Type | Description | Default |
|---|---|---|---|
dev_hw_info |
SdioDeviceHwInfo
|
No default | |
funcs_hw_info |
[8]
|
No default | |
host_max_transfer_size |
uint32
|
No default |
SdioRwTxn resource
Defined in fuchsia.hardware.sdio/sdio.fidl
| Name | Type | Description | Default |
|---|---|---|---|
addr |
uint32
|
No default | |
data_size |
uint32
|
No default | |
incr |
bool
|
No default | |
write |
bool
|
No default | |
use_dma |
bool
|
No default | |
dma_vmo |
handle<vmo>
|
Used if use_dma is true |
No default |
virt |
vector<uint8>
|
Used if use_dma is false |
No default |
buf_offset |
uint64
|
offset into dma_vmo or virt |
No default |
SdioRwTxn resource
Defined in fuchsia.hardware.sdio/sdio.fidl
| Name | Type | Description | Default |
|---|---|---|---|
addr |
uint32
|
No default | |
data_size |
uint32
|
No default | |
incr |
bool
|
No default | |
write |
bool
|
No default | |
use_dma |
bool
|
No default | |
dma_vmo |
handle<vmo>?
|
Used if use_dma is true |
No default |
virt |
vector<uint8>[2097152]?
|
Used if use_dma is false |
No default |
buf_offset |
uint64
|
offset into dma_vmo or virt |
No default |
SdioRwTxnNew resource
Defined in fuchsia.hardware.sdio/sdio.fidl
| Name | Type | Description | Default |
|---|---|---|---|
addr |
uint32
|
No default | |
incr |
bool
|
No default | |
write |
bool
|
No default | |
buffers |
vector<fuchsia.hardware.sdmmc/SdmmcBufferRegion>
|
No default |
ENUMS
SdioCard strict
Type: uint32
Defined in fuchsia.hardware.sdio/sdio.fidl
| Name | Value | Description |
|---|---|---|
MULTI_BLOCK |
1 |
|
SRW |
2 |
|
DIRECT_COMMAND |
4 |
|
SUSPEND_RESUME |
8 |
|
LOW_SPEED |
16 |
|
HIGH_SPEED |
32 |
|
HIGH_POWER |
64 |
|
FOUR_BIT_BUS |
128 |
|
HS_SDR12 |
256 |
|
HS_SDR25 |
512 |
|
UHS_SDR50 |
1024 |
|
UHS_SDR104 |
2048 |
|
UHS_DDR50 |
4096 |
|
TYPE_A |
8192 |
|
TYPE_B |
16384 |
|
TYPE_C |
32768 |
|
TYPE_D |
65536 |
SdioDeviceCapabilities strict
Type: uint32
Defined in fuchsia.hardware.sdio/sdio.fidl
| Name | Value | Description |
|---|---|---|
MULTI_BLOCK |
1 |
|
SRW |
2 |
|
DIRECT_COMMAND |
4 |
|
SUSPEND_RESUME |
8 |
|
LOW_SPEED |
16 |
|
HIGH_SPEED |
32 |
|
HIGH_POWER |
64 |
|
FOUR_BIT_BUS |
128 |
|
HS_SDR12 |
256 |
|
HS_SDR25 |
512 |
|
UHS_SDR50 |
1024 |
|
UHS_SDR104 |
2048 |
|
UHS_DDR50 |
4096 |
|
TYPE_A |
8192 |
|
TYPE_B |
16384 |
|
TYPE_C |
32768 |
|
TYPE_D |
65536 |
UNIONS
Device_DisableFnIntr_Result strict
Defined in fuchsia.hardware.sdio/sdio.fidl
| Name | Type | Description |
|---|---|---|
response |
Device_DisableFnIntr_Response
|
|
err |
zx/status
|
Device_DisableFn_Result strict
Defined in fuchsia.hardware.sdio/sdio.fidl
| Name | Type | Description |
|---|---|---|
response |
Device_DisableFn_Response
|
|
err |
zx/status
|
Device_DoRwByte_Result strict
Defined in fuchsia.hardware.sdio/sdio.fidl
| Name | Type | Description |
|---|---|---|
response |
Device_DoRwByte_Response
|
|
err |
zx/status
|
Device_DoRwTxn_Result strict resource
Defined in fuchsia.hardware.sdio/sdio.fidl
| Name | Type | Description |
|---|---|---|
response |
Device_DoRwTxn_Response
|
|
err |
zx/status
|
Device_DoVendorControlRwByte_Result strict
Defined in fuchsia.hardware.sdio/sdio.fidl
| Name | Type | Description |
|---|---|---|
response |
Device_DoVendorControlRwByte_Response
|
|
err |
zx/status
|
Device_EnableFnIntr_Result strict
Defined in fuchsia.hardware.sdio/sdio.fidl
| Name | Type | Description |
|---|---|---|
response |
Device_EnableFnIntr_Response
|
|
err |
zx/status
|
Device_EnableFn_Result strict
Defined in fuchsia.hardware.sdio/sdio.fidl
| Name | Type | Description |
|---|---|---|
response |
Device_EnableFn_Response
|
|
err |
zx/status
|
Device_GetBlockSize_Result strict
Defined in fuchsia.hardware.sdio/sdio.fidl
| Name | Type | Description |
|---|---|---|
response |
Device_GetBlockSize_Response
|
|
err |
zx/status
|
Device_GetDevHwInfo_Result strict
Defined in fuchsia.hardware.sdio/sdio.fidl
| Name | Type | Description |
|---|---|---|
response |
Device_GetDevHwInfo_Response
|
|
err |
zx/status
|
Device_GetInBandIntr_Result strict resource
Defined in fuchsia.hardware.sdio/sdio.fidl
| Name | Type | Description |
|---|---|---|
response |
Device_GetInBandIntr_Response
|
|
err |
zx/status
|
Device_IntrPending_Result strict
Defined in fuchsia.hardware.sdio/sdio.fidl
| Name | Type | Description |
|---|---|---|
response |
Device_IntrPending_Response
|
|
err |
zx/status
|
Device_IoAbort_Result strict
Defined in fuchsia.hardware.sdio/sdio.fidl
| Name | Type | Description |
|---|---|---|
response |
Device_IoAbort_Response
|
|
err |
zx/status
|
Device_UpdateBlockSize_Result strict
Defined in fuchsia.hardware.sdio/sdio.fidl
| Name | Type | Description |
|---|---|---|
response |
Device_UpdateBlockSize_Response
|
|
err |
zx/status
|
CONSTANTS
| Name | Value | Type | Description |
|---|---|---|---|
| MAX_TRANSFER_SIZE |
2097152
|
uint32 |
SDIO max block size is 2048, so this is an arbitrary limit of 1024 blocks. |
| SDIO_FN_1 |
1
|
uint8 |
|
| SDIO_FN_2 |
2
|
uint8 |
|
| SDIO_MAX_FUNCS |
8
|
uint8 |
Including func 0 |