Blame view

RIOT/tests/unittests/tests-mtd/tests-mtd.c 7.98 KB
a752c7ab   elopes   add first test an...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
  /*
   * Copyright (C) 2016 OTA keys S.A.
   *
   * This file is subject to the terms and conditions of the GNU Lesser
   * General Public License v2.1. See the file LICENSE in the top level
   * directory for more details.
   */
  
  /**
   * @{
   *
   * @file
   */
  #include <string.h>
  #include <errno.h>
  
  #include "embUnit.h"
  
  #include "mtd.h"
  #include "board.h"
  
  #if MODULE_VFS
  #include <fcntl.h>
  #include <stdio.h>
  #include "vfs.h"
  #endif
  
  /* Define MTD_0 in board.h to use the board mtd if any */
  #ifdef MTD_0
  #define dev (MTD_0)
  #else
  /* Test mock object implementing a simple RAM-based mtd */
  #ifndef SECTOR_COUNT
  #define SECTOR_COUNT 4
  #endif
  #ifndef PAGE_PER_SECTOR
  #define PAGE_PER_SECTOR 4
  #endif
  #ifndef PAGE_SIZE
  #define PAGE_SIZE 128
  #endif
  
  static uint8_t dummy_memory[PAGE_PER_SECTOR * PAGE_SIZE * SECTOR_COUNT];
  
  static int init(mtd_dev_t *dev)
  {
      (void)dev;
  
      memset(dummy_memory, 0xff, sizeof(dummy_memory));
      return 0;
  }
  
  static int read(mtd_dev_t *dev, void *buff, uint32_t addr, uint32_t size)
  {
      (void)dev;
  
      if (addr + size > sizeof(dummy_memory)) {
          return -EOVERFLOW;
      }
      memcpy(buff, dummy_memory + addr, size);
  
      return size;
  }
  
  static int write(mtd_dev_t *dev, const void *buff, uint32_t addr, uint32_t size)
  {
      (void)dev;
  
      if (addr + size > sizeof(dummy_memory)) {
          return -EOVERFLOW;
      }
      if (size > PAGE_SIZE) {
          return -EOVERFLOW;
      }
      memcpy(dummy_memory + addr, buff, size);
  
      return size;
  }
  
  static int erase(mtd_dev_t *dev, uint32_t addr, uint32_t size)
  {
      (void)dev;
  
      if (size % (PAGE_PER_SECTOR * PAGE_SIZE) != 0) {
          return -EOVERFLOW;
      }
      if (addr % (PAGE_PER_SECTOR * PAGE_SIZE) != 0) {
          return -EOVERFLOW;
      }
      if (addr + size > sizeof(dummy_memory)) {
          return -EOVERFLOW;
      }
      memset(dummy_memory + addr, 0xff, size);
  
      return 0;
  }
  
  static int power(mtd_dev_t *dev, enum mtd_power_state power)
  {
      (void)dev;
      (void)power;
      return 0;
  }
  
  static const mtd_desc_t driver = {
      .init = init,
      .read = read,
      .write = write,
      .erase = erase,
      .power = power,
  };
  
  static mtd_dev_t _dev = {
      .driver = &driver,
      .sector_count = SECTOR_COUNT,
      .pages_per_sector = PAGE_PER_SECTOR,
      .page_size = PAGE_SIZE,
  };
  
  static mtd_dev_t *dev = (mtd_dev_t*) &_dev;
  
  #endif /* MTD_0 */
  
  static void setup_teardown(void)
  {
      mtd_erase(dev, 0, dev->pages_per_sector * dev->page_size);
  }
  
  static void test_mtd_init(void)
  {
      int ret = mtd_init(dev);
      TEST_ASSERT_EQUAL_INT(0, ret);
  }
  
  static void test_mtd_erase(void)
  {
      /* Erase first sector */
      int ret = mtd_erase(dev, 0, dev->pages_per_sector * dev->page_size);
      TEST_ASSERT_EQUAL_INT(0, ret);
  
      /* Erase with wrong size (les than sector size) */
      ret = mtd_erase(dev, 0, dev->page_size);
      TEST_ASSERT_EQUAL_INT(-EOVERFLOW, ret);
  
      /* Unaligned erase */
      ret = mtd_erase(dev, dev->page_size, dev->page_size);
      TEST_ASSERT_EQUAL_INT(-EOVERFLOW, ret);
  
      /* Erase 2nd - 3rd sector */
      ret = mtd_erase(dev, dev->pages_per_sector * dev->page_size,
                      dev->pages_per_sector * dev->page_size * 2);
      TEST_ASSERT_EQUAL_INT(0, ret);
  
      /* Erase out of memory area */
      ret = mtd_erase(dev, dev->pages_per_sector * dev->page_size * dev->sector_count,
                      dev->pages_per_sector * dev->page_size);
      TEST_ASSERT_EQUAL_INT(-EOVERFLOW, ret);
  }
  
  static void test_mtd_write_erase(void)
  {
      const char buf[] = "ABCDEFGHIJK";
      uint8_t buf_empty[] = {0xff, 0xff, 0xff};
      char buf_read[sizeof(buf) + sizeof(buf_empty)];
      memset(buf_read, 0, sizeof(buf_read));
  
      int ret = mtd_write(dev, buf, sizeof(buf_empty), sizeof(buf));
      TEST_ASSERT_EQUAL_INT(sizeof(buf), ret);
  
      ret = mtd_erase(dev, 0, dev->pages_per_sector * dev->page_size);
      TEST_ASSERT_EQUAL_INT(0, ret);
  
      uint8_t expected[sizeof(buf_read)];
      memset(expected, 0xff, sizeof(expected));
      ret = mtd_read(dev, buf_read, 0, sizeof(buf_read));
      TEST_ASSERT_EQUAL_INT(sizeof(buf_read), ret);
      TEST_ASSERT_EQUAL_INT(0, memcmp(expected, buf_read, sizeof(buf_read)));
  
  }
  
  static void test_mtd_write_read(void)
  {
      const char buf[] = "ABCDEFGH";
      uint8_t buf_empty[] = {0xff, 0xff, 0xff};
      char buf_read[sizeof(buf) + sizeof(buf_empty)];
      memset(buf_read, 0, sizeof(buf_read));
  
      /* Basic write / read */
      int ret = mtd_write(dev, buf, 0, sizeof(buf));
      TEST_ASSERT_EQUAL_INT(sizeof(buf), ret);
  
      ret = mtd_read(dev, buf_read, 0, sizeof(buf_read));
      TEST_ASSERT_EQUAL_INT(sizeof(buf_read), ret);
      TEST_ASSERT_EQUAL_INT(0, memcmp(buf, buf_read, sizeof(buf)));
      TEST_ASSERT_EQUAL_INT(0, memcmp(buf_empty, buf_read + sizeof(buf), sizeof(buf_empty)));
  
      /* Unaligned write / read */
      ret = mtd_write(dev, buf, dev->page_size + sizeof(buf_empty), sizeof(buf));
      TEST_ASSERT_EQUAL_INT(sizeof(buf), ret);
  
      ret = mtd_read(dev, buf_read, dev->page_size, sizeof(buf_read));
      TEST_ASSERT_EQUAL_INT(sizeof(buf_read), ret);
      TEST_ASSERT_EQUAL_INT(0, memcmp(buf_empty, buf_read, sizeof(buf_empty)));
      TEST_ASSERT_EQUAL_INT(0, memcmp(buf, buf_read + sizeof(buf_empty), sizeof(buf)));
  
      /* out of bounds write (addr) */
      ret = mtd_write(dev, buf, dev->pages_per_sector * dev->page_size * dev->sector_count,
                      sizeof(buf));
      TEST_ASSERT_EQUAL_INT(-EOVERFLOW, ret);
  
      /* out of bounds write (addr + count) */
      ret = mtd_write(dev, buf, (dev->pages_per_sector * dev->page_size * dev->sector_count)
                      - (sizeof(buf) / 2), sizeof(buf));
      TEST_ASSERT_EQUAL_INT(-EOVERFLOW, ret);
  }
  
  #ifdef MTD_0
  static void test_mtd_write_read_flash(void)
  {
      const uint8_t buf1[] = {0xee, 0xdd, 0xcc};
      const uint8_t buf2[] = {0x33, 0x33, 0x33};
      const uint8_t buf_expected[] = {0x22, 0x11, 0x0};
      uint8_t buf_empty[] = {0xff, 0xff, 0xff};
      char buf_read[sizeof(buf_expected) + sizeof(buf_empty)];
      memset(buf_read, 0, sizeof(buf_read));
  
      /* Test flash AND behavior. This test will fail if the mtd is not a flash */
  
      /* Basic write / read */
      int ret = mtd_write(dev, buf1, 0, sizeof(buf1));
      TEST_ASSERT_EQUAL_INT(sizeof(buf1), ret);
      ret = mtd_write(dev, buf2, 0, sizeof(buf2));
      TEST_ASSERT_EQUAL_INT(sizeof(buf2), ret);
  
      ret = mtd_read(dev, buf_read, 0, sizeof(buf_read));
      TEST_ASSERT_EQUAL_INT(sizeof(buf_read), ret);
      TEST_ASSERT_EQUAL_INT(0, memcmp(buf_expected, buf_read, sizeof(buf_expected)));
      TEST_ASSERT_EQUAL_INT(0, memcmp(buf_empty, buf_read + sizeof(buf_expected), sizeof(buf_empty)));
  }
  #endif
  
  #if MODULE_VFS
  static void test_mtd_vfs(void)
  {
      int fd;
      fd = vfs_bind(VFS_ANY_FD, O_RDWR, &mtd_vfs_ops, dev);
      const char buf[] = "mnopqrst";
      uint8_t buf_empty[] = {0xff, 0xff, 0xff};
      char buf_read[sizeof(buf) + sizeof(buf_empty)];
      memset(buf_read, 0, sizeof(buf_read));
  
      int ret = vfs_lseek(fd, sizeof(buf_empty), SEEK_SET);
      TEST_ASSERT_EQUAL_INT(sizeof(buf_empty), ret);
      ret = vfs_write(fd, buf, sizeof(buf));
      TEST_ASSERT_EQUAL_INT(sizeof(buf), ret);
      ret = vfs_lseek(fd, 0, SEEK_SET);
      TEST_ASSERT_EQUAL_INT(0, ret);
      ret = vfs_read(fd, buf_read, sizeof(buf_read));
      TEST_ASSERT_EQUAL_INT(sizeof(buf_read), ret);
      TEST_ASSERT_EQUAL_INT(0, memcmp(buf_empty, buf_read, sizeof(buf_empty)));
      TEST_ASSERT_EQUAL_INT(0, memcmp(buf, buf_read + sizeof(buf_empty), sizeof(buf)));
  
      ret = vfs_lseek(fd, 0, SEEK_END);
      TEST_ASSERT(ret > 0);
      ret = vfs_write(fd, buf, sizeof(buf));
      /* Attempted to write past the device memory */
      TEST_ASSERT(ret < 0);
  }
  #endif
  
  Test *tests_mtd_tests(void)
  {
      EMB_UNIT_TESTFIXTURES(fixtures) {
          new_TestFixture(test_mtd_init),
          new_TestFixture(test_mtd_erase),
          new_TestFixture(test_mtd_write_erase),
          new_TestFixture(test_mtd_write_read),
  #ifdef MTD_0
          new_TestFixture(test_mtd_write_read_flash),
  #endif
  #if MODULE_VFS
          new_TestFixture(test_mtd_vfs),
  #endif
      };
  
      EMB_UNIT_TESTCALLER(mtd_tests, setup_teardown, setup_teardown, fixtures);
  
      return (Test *)&mtd_tests;
  }
  
  void tests_mtd(void)
  {
      TESTS_RUN(tests_mtd_tests());
  }
  /** @} */