Zephyr API Documentation  3.6.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
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
30#include <zephyr/kernel.h>
31#include <zephyr/types.h>
32#include <zephyr/sys/dlist.h>
33
34#ifdef __cplusplus
35extern "C" {
36#endif
37
43#define DISK_IOCTL_GET_SECTOR_COUNT 1
45#define DISK_IOCTL_GET_SECTOR_SIZE 2
47#define DISK_IOCTL_RESERVED 3
49#define DISK_IOCTL_GET_ERASE_BLOCK_SZ 4
51#define DISK_IOCTL_CTRL_SYNC 5
52
58#define DISK_STATUS_OK 0x00
60#define DISK_STATUS_UNINIT 0x01
62#define DISK_STATUS_NOMEDIA 0x02
64#define DISK_STATUS_WR_PROTECT 0x04
65
66struct disk_operations;
67
71struct disk_info {
75 const char *name;
77 const struct disk_operations *ops;
79 const struct device *dev;
80};
81
86 int (*init)(struct disk_info *disk);
87 int (*status)(struct disk_info *disk);
88 int (*read)(struct disk_info *disk, uint8_t *data_buf,
89 uint32_t start_sector, uint32_t num_sector);
90 int (*write)(struct disk_info *disk, const uint8_t *data_buf,
91 uint32_t start_sector, uint32_t num_sector);
92 int (*ioctl)(struct disk_info *disk, uint8_t cmd, void *buff);
93};
94
103
112
113#ifdef __cplusplus
114}
115#endif
116
121#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:54
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:399
Disk info.
Definition: disk.h:71
const struct disk_operations * ops
Disk operations.
Definition: disk.h:77
sys_dnode_t node
Internally used list node.
Definition: disk.h:73
const char * name
Disk name.
Definition: disk.h:75
const struct device * dev
Device associated to this disk.
Definition: disk.h:79
Disk operations.
Definition: disk.h:85
int(* read)(struct disk_info *disk, uint8_t *data_buf, uint32_t start_sector, uint32_t num_sector)
Definition: disk.h:88
int(* ioctl)(struct disk_info *disk, uint8_t cmd, void *buff)
Definition: disk.h:92
int(* status)(struct disk_info *disk)
Definition: disk.h:87
int(* write)(struct disk_info *disk, const uint8_t *data_buf, uint32_t start_sector, uint32_t num_sector)
Definition: disk.h:90
int(* init)(struct disk_info *disk)
Definition: disk.h:86