1 /*
2 * Copyright (c) 2016 Intel Corporation.
3 * Copyright (c) 2021,2023 Nordic Semiconductor ASA
4 *
5 * SPDX-License-Identifier: Apache-2.0
6 */
7
8 #include <string.h>
9 #include <zephyr/types.h>
10 #include <zephyr/drivers/disk.h>
11 #include <errno.h>
12 #include <zephyr/init.h>
13 #include <zephyr/device.h>
14 #include <zephyr/logging/log.h>
15
16 LOG_MODULE_REGISTER(ramdisk, CONFIG_RAMDISK_LOG_LEVEL);
17
18 struct ram_disk_data {
19 struct disk_info info;
20 const size_t sector_size;
21 const size_t sector_count;
22 uint8_t *const buf;
23 };
24
25 struct ram_disk_config {
26 const size_t sector_size;
27 const size_t sector_count;
28 const size_t size;
29 uint8_t *const buf;
30 };
31
lba_to_address(const struct device * dev,uint32_t lba)32 static void *lba_to_address(const struct device *dev, uint32_t lba)
33 {
34 const struct ram_disk_config *config = dev->config;
35
36 return &config->buf[lba * config->sector_size];
37 }
38
disk_ram_access_status(struct disk_info * disk)39 static int disk_ram_access_status(struct disk_info *disk)
40 {
41 return DISK_STATUS_OK;
42 }
43
disk_ram_access_read(struct disk_info * disk,uint8_t * buff,uint32_t sector,uint32_t count)44 static int disk_ram_access_read(struct disk_info *disk, uint8_t *buff,
45 uint32_t sector, uint32_t count)
46 {
47 const struct device *dev = disk->dev;
48 const struct ram_disk_config *config = dev->config;
49 uint32_t last_sector = sector + count;
50
51 if (last_sector < sector || last_sector > config->sector_count) {
52 LOG_ERR("Sector %" PRIu32 " is outside the range %zu",
53 last_sector, config->sector_count);
54 return -EIO;
55 }
56
57 memcpy(buff, lba_to_address(dev, sector), count * config->sector_size);
58
59 return 0;
60 }
61
disk_ram_access_write(struct disk_info * disk,const uint8_t * buff,uint32_t sector,uint32_t count)62 static int disk_ram_access_write(struct disk_info *disk, const uint8_t *buff,
63 uint32_t sector, uint32_t count)
64 {
65 const struct device *dev = disk->dev;
66 const struct ram_disk_config *config = dev->config;
67 uint32_t last_sector = sector + count;
68
69 if (last_sector < sector || last_sector > config->sector_count) {
70 LOG_ERR("Sector %" PRIu32 " is outside the range %zu",
71 last_sector, config->sector_count);
72 return -EIO;
73 }
74
75 memcpy(lba_to_address(dev, sector), buff, count * config->sector_size);
76
77 return 0;
78 }
79
disk_ram_access_erase(struct disk_info * disk,uint32_t sector,uint32_t count)80 static int disk_ram_access_erase(struct disk_info *disk, uint32_t sector,
81 uint32_t count)
82 {
83 const struct device *dev = disk->dev;
84 const struct ram_disk_config *config = dev->config;
85 uint32_t last_sector = sector + count;
86
87 if (last_sector < sector || last_sector > config->sector_count) {
88 LOG_ERR("Sector %" PRIu32 " is outside the range %zu",
89 last_sector, config->sector_count);
90 return -EINVAL;
91 }
92
93 memset(lba_to_address(dev, sector), 0, count * config->sector_size);
94
95 return 0;
96 }
97
disk_ram_access_ioctl(struct disk_info * disk,uint8_t cmd,void * buff)98 static int disk_ram_access_ioctl(struct disk_info *disk, uint8_t cmd, void *buff)
99 {
100 const struct ram_disk_config *config = disk->dev->config;
101
102 switch (cmd) {
103 case DISK_IOCTL_CTRL_SYNC:
104 break;
105 case DISK_IOCTL_GET_SECTOR_COUNT:
106 *(uint32_t *)buff = config->sector_count;
107 break;
108 case DISK_IOCTL_GET_SECTOR_SIZE:
109 *(uint32_t *)buff = config->sector_size;
110 break;
111 case DISK_IOCTL_GET_ERASE_BLOCK_SZ:
112 *(uint32_t *)buff = 1U;
113 break;
114 case DISK_IOCTL_CTRL_INIT:
115 case DISK_IOCTL_CTRL_DEINIT:
116 break;
117 default:
118 return -EINVAL;
119 }
120
121 return 0;
122 }
123
disk_ram_access_init(struct disk_info * disk)124 static int disk_ram_access_init(struct disk_info *disk)
125 {
126 return disk_ram_access_ioctl(disk, DISK_IOCTL_CTRL_INIT, NULL);
127 }
128
disk_ram_init(const struct device * dev)129 static int disk_ram_init(const struct device *dev)
130 {
131 struct disk_info *info = dev->data;
132
133 info->dev = dev;
134
135 return disk_access_register(info);
136 }
137
138 static const struct disk_operations ram_disk_ops = {
139 .init = disk_ram_access_init,
140 .status = disk_ram_access_status,
141 .read = disk_ram_access_read,
142 .write = disk_ram_access_write,
143 .erase = disk_ram_access_erase,
144 .ioctl = disk_ram_access_ioctl,
145 };
146
147 #define DT_DRV_COMPAT zephyr_ram_disk
148
149 #define RAMDISK_DEVICE_SIZE(n) \
150 (DT_INST_PROP(n, sector_size) * DT_INST_PROP(n, sector_count))
151
152 #define RAMDISK_DEVICE_CONFIG_DEFINE_MEMREG(n) \
153 BUILD_ASSERT(RAMDISK_DEVICE_SIZE(n) <= \
154 DT_REG_SIZE(DT_INST_PHANDLE(n, ram_region)), \
155 "Disk size is smaller than memory region"); \
156 \
157 static struct ram_disk_config disk_config_##n = { \
158 .sector_size = DT_INST_PROP(n, sector_size), \
159 .sector_count = DT_INST_PROP(n, sector_count), \
160 .size = RAMDISK_DEVICE_SIZE(n), \
161 .buf = UINT_TO_POINTER(DT_REG_ADDR(DT_INST_PHANDLE(n, ram_region))), \
162 }
163
164 #define RAMDISK_DEVICE_CONFIG_DEFINE_LOCAL(n) \
165 static uint8_t disk_buf_##n[DT_INST_PROP(n, sector_size) * \
166 DT_INST_PROP(n, sector_count)]; \
167 \
168 static struct ram_disk_config disk_config_##n = { \
169 .sector_size = DT_INST_PROP(n, sector_size), \
170 .sector_count = DT_INST_PROP(n, sector_count), \
171 .size = RAMDISK_DEVICE_SIZE(n), \
172 .buf = disk_buf_##n, \
173 }
174
175 #define RAMDISK_DEVICE_CONFIG_DEFINE(n) \
176 COND_CODE_1(DT_INST_NODE_HAS_PROP(n, ram_region), \
177 (RAMDISK_DEVICE_CONFIG_DEFINE_MEMREG(n)), \
178 (RAMDISK_DEVICE_CONFIG_DEFINE_LOCAL(n)))
179
180 #define RAMDISK_DEVICE_DEFINE(n) \
181 \
182 static struct disk_info disk_info_##n = { \
183 .name = DT_INST_PROP(n, disk_name), \
184 .ops = &ram_disk_ops, \
185 }; \
186 \
187 RAMDISK_DEVICE_CONFIG_DEFINE(n); \
188 \
189 DEVICE_DT_INST_DEFINE(n, disk_ram_init, NULL, \
190 &disk_info_##n, &disk_config_##n, \
191 POST_KERNEL, CONFIG_KERNEL_INIT_PRIORITY_DEVICE, \
192 &ram_disk_ops);
193
194 DT_INST_FOREACH_STATUS_OKAY(RAMDISK_DEVICE_DEFINE)
195
