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
disk.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2016 Intel Corporation.
3 * Copyright (c) 2021 Nordic Semiconductor ASA
4 *
5 * SPDX-License-Identifier: Apache-2.0
6 */
7
18#ifndef ZEPHYR_INCLUDE_DRIVERS_DISK_H_
19#define ZEPHYR_INCLUDE_DRIVERS_DISK_H_
20
28#include <zephyr/kernel.h>
29#include <zephyr/types.h>
30#include <zephyr/sys/dlist.h>
31
32#ifdef __cplusplus
33extern "C" {
34#endif
35
41#define DISK_IOCTL_GET_SECTOR_COUNT 1
43#define DISK_IOCTL_GET_SECTOR_SIZE 2
45#define DISK_IOCTL_RESERVED 3
47#define DISK_IOCTL_GET_ERASE_BLOCK_SZ 4
49#define DISK_IOCTL_CTRL_SYNC 5
50
56#define DISK_STATUS_OK 0x00
58#define DISK_STATUS_UNINIT 0x01
60#define DISK_STATUS_NOMEDIA 0x02
62#define DISK_STATUS_WR_PROTECT 0x04
63
64struct disk_operations;
65
69struct disk_info {
73 char *name;
75 const struct disk_operations *ops;
77 const struct device *dev;
78};
79
84 int (*init)(struct disk_info *disk);
85 int (*status)(struct disk_info *disk);
86 int (*read)(struct disk_info *disk, uint8_t *data_buf,
87 uint32_t start_sector, uint32_t num_sector);
88 int (*write)(struct disk_info *disk, const uint8_t *data_buf,
89 uint32_t start_sector, uint32_t num_sector);
90 int (*ioctl)(struct disk_info *disk, uint8_t cmd, void *buff);
91};
92
101
110
111#ifdef __cplusplus
112}
113#endif
114
119#endif /* ZEPHYR_INCLUDE_DRIVERS_DISK_H_ */
int disk_access_register(struct disk_info *disk)
Register disk.
int disk_access_unregister(struct disk_info *disk)
Unregister disk.
struct _dnode sys_dnode_t
Doubly-linked list node structure.
Definition: dlist.h:55
static void cmd(uint32_t command)
Execute a display list command by co-processor engine.
Definition: ft8xx_reference_api.h:153
Public kernel APIs.
__UINT32_TYPE__ uint32_t
Definition: stdint.h:90
__UINT8_TYPE__ uint8_t
Definition: stdint.h:88
Runtime device structure (in ROM) per driver instance.
Definition: device.h:381
Disk info.
Definition: disk.h:69
const struct disk_operations * ops
Disk operations.
Definition: disk.h:75
char * name
Disk name.
Definition: disk.h:73
sys_dnode_t node
Internally used list node.
Definition: disk.h:71
const struct device * dev
Device associated to this disk.
Definition: disk.h:77
Disk operations.
Definition: disk.h:83
int(* read)(struct disk_info *disk, uint8_t *data_buf, uint32_t start_sector, uint32_t num_sector)
Definition: disk.h:86
int(* ioctl)(struct disk_info *disk, uint8_t cmd, void *buff)
Definition: disk.h:90
int(* status)(struct disk_info *disk)
Definition: disk.h:85
int(* write)(struct disk_info *disk, const uint8_t *data_buf, uint32_t start_sector, uint32_t num_sector)
Definition: disk.h:88
int(* init)(struct disk_info *disk)
Definition: disk.h:84