Zephyr API Documentation 4.0.0-rc2
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
disk.h File Reference

Disk Driver Interface. More...

#include <zephyr/kernel.h>
#include <zephyr/types.h>
#include <zephyr/sys/dlist.h>

Go to the source code of this file.

Data Structures

struct  disk_info
 Disk info. More...
 
struct  disk_operations
 Disk operations. More...
 

Macros

#define DISK_IOCTL_GET_SECTOR_COUNT   1
 Possible Cmd Codes for disk_ioctl()
 
#define DISK_IOCTL_GET_SECTOR_SIZE   2
 Get the size of a disk SECTOR in bytes.
 
#define DISK_IOCTL_RESERVED   3
 reserved.
 
#define DISK_IOCTL_GET_ERASE_BLOCK_SZ   4
 How many sectors constitute a FLASH Erase block.
 
#define DISK_IOCTL_CTRL_SYNC   5
 Commit any cached read/writes to disk.
 
#define DISK_IOCTL_CTRL_INIT   6
 Initialize the disk.
 
#define DISK_IOCTL_CTRL_DEINIT   7
 Deinitialize the disk.
 
#define DISK_STATUS_OK   0x00
 Possible return bitmasks for disk_status()
 
#define DISK_STATUS_UNINIT   0x01
 Disk status uninitialized.
 
#define DISK_STATUS_NOMEDIA   0x02
 Disk status no media.
 
#define DISK_STATUS_WR_PROTECT   0x04
 Disk status write protected.
 

Functions

int disk_access_register (struct disk_info *disk)
 Register disk.
 
int disk_access_unregister (struct disk_info *disk)
 Unregister disk.
 

Detailed Description

Disk Driver Interface.

This file contains interface for disk access. Apart from disks, various other storage media like Flash and RAM disks may implement this interface to be used by various higher layers(consumers) like USB Mass storage and Filesystems.