|
| 1 | +/* |
| 2 | + * SPDX-FileCopyrightText: 2025 Espressif Systems (Shanghai) CO LTD |
| 3 | + * |
| 4 | + * SPDX-License-Identifier: Apache-2.0 |
| 5 | + * |
| 6 | + * Linux host partition API test |
| 7 | + */ |
| 8 | + |
| 9 | +#include <string.h> |
| 10 | +#include <unistd.h> |
| 11 | +#include "esp_partition.h" |
| 12 | +#include "esp_private/partition_linux.h" |
| 13 | +#include "unity.h" |
| 14 | +#include "unity_fixture.h" |
| 15 | + |
| 16 | +const char *TAG = "partition_bdl_test"; |
| 17 | + |
| 18 | +TEST_GROUP(partition_bdl); |
| 19 | + |
| 20 | +TEST_SETUP(partition_bdl) |
| 21 | +{ |
| 22 | +} |
| 23 | + |
| 24 | +TEST_TEAR_DOWN(partition_bdl) |
| 25 | +{ |
| 26 | +} |
| 27 | + |
| 28 | +/* Test all the basic Block Device Layer APIs working correctly over emulated esp_partition instance. |
| 29 | + * NOR flash behavior expected. |
| 30 | + * */ |
| 31 | +TEST(partition_bdl, test_partition_bdl_ops) |
| 32 | +{ |
| 33 | + //get the block-device interface instance |
| 34 | + esp_blockdev_handle_t part_blockdev = NULL; |
| 35 | + TEST_ESP_OK(esp_partition_get_blockdev(ESP_PARTITION_TYPE_DATA, ESP_PARTITION_SUBTYPE_ANY, "storage1", &part_blockdev)); |
| 36 | + |
| 37 | + const size_t data_size = 256; |
| 38 | + uint8_t test_data[data_size]; |
| 39 | + const off_t target_addr = 3*4*1024; |
| 40 | + uint8_t data_buffer[data_size]; |
| 41 | + memset((void*)data_buffer, 0, data_size); |
| 42 | + |
| 43 | + //erase the first sector data from the blockdev and check it's really wiped |
| 44 | + TEST_ESP_OK(part_blockdev->ops->erase(part_blockdev, target_addr, part_blockdev->geometry.erase_size)); |
| 45 | + memset((void*)test_data, 0xFF, data_size); //erased NOR flash sector contains only 1s |
| 46 | + |
| 47 | + TEST_ESP_OK(part_blockdev->ops->read(part_blockdev, data_buffer, sizeof(data_buffer), target_addr, data_size)); |
| 48 | + TEST_ASSERT_EQUAL(0, memcmp(test_data, data_buffer, data_size)); |
| 49 | + |
| 50 | + //write to the blockdev |
| 51 | + memset((void*)test_data, 'A', data_size); |
| 52 | + TEST_ESP_OK(part_blockdev->ops->write(part_blockdev, test_data, target_addr, data_size)); |
| 53 | + |
| 54 | + //read from the blockdev the data written before |
| 55 | + TEST_ESP_OK(part_blockdev->ops->read(part_blockdev, data_buffer, sizeof(data_buffer), target_addr, data_size)); |
| 56 | + TEST_ASSERT_EQUAL(0, memcmp(test_data, data_buffer, data_size)); |
| 57 | + |
| 58 | + //release the BDL object |
| 59 | + TEST_ESP_OK(part_blockdev->ops->release(part_blockdev)); |
| 60 | +} |
| 61 | + |
| 62 | +/* Test parallel access to two independent partitions through BDL interface. |
| 63 | + * Use both 'esp_partition_t' and type-subtype-label BDL getters. |
| 64 | + * NOR flash behavior expected. |
| 65 | + * */ |
| 66 | +TEST(partition_bdl, test_two_partitions_bdl_ops) |
| 67 | +{ |
| 68 | + //get the block-device interface instance for partition 'storage1' |
| 69 | + esp_blockdev_handle_t part_blockdev_1 = NULL; |
| 70 | + TEST_ESP_OK(esp_partition_get_blockdev(ESP_PARTITION_TYPE_DATA, ESP_PARTITION_SUBTYPE_ANY, "storage1", &part_blockdev_1)); |
| 71 | + |
| 72 | + //get pointer to esp_partition_t object for partition 'storage2' |
| 73 | + esp_partition_iterator_t iter = esp_partition_find(ESP_PARTITION_TYPE_DATA, ESP_PARTITION_SUBTYPE_ANY, "storage2"); |
| 74 | + TEST_ASSERT_NOT_NULL(iter); |
| 75 | + esp_partition_t *part = (esp_partition_t*)esp_partition_get(iter); |
| 76 | + TEST_ASSERT_NOT_NULL(part); |
| 77 | + esp_partition_iterator_release(iter); |
| 78 | + |
| 79 | + esp_blockdev_handle_t part_blockdev_2 = NULL; |
| 80 | + TEST_ESP_OK(esp_partition_ptr_get_blockdev(part, &part_blockdev_2)); |
| 81 | + |
| 82 | + //erase & write & read data on both partitions in parallel |
| 83 | + const size_t data_size = 256; |
| 84 | + uint8_t test_data[data_size]; |
| 85 | + const off_t target_addr = 3*4*1024; |
| 86 | + uint8_t data_buffer_1[data_size]; |
| 87 | + uint8_t data_buffer_2[data_size]; |
| 88 | + memset((void*)data_buffer_1, 0, data_size); |
| 89 | + memset((void*)data_buffer_2, 0, data_size); |
| 90 | + |
| 91 | + //erase the first sector data from the blockdev and check it's really wiped |
| 92 | + TEST_ESP_OK(part_blockdev_1->ops->erase(part_blockdev_1, target_addr, part_blockdev_1->geometry.erase_size)); |
| 93 | + TEST_ESP_OK(part_blockdev_2->ops->erase(part_blockdev_2, target_addr, part_blockdev_2->geometry.erase_size)); |
| 94 | + memset((void*)test_data, 0xFF, data_size); //erased NOR flash sector contains only 1s |
| 95 | + |
| 96 | + TEST_ESP_OK(part_blockdev_1->ops->read(part_blockdev_1, data_buffer_1, sizeof(data_buffer_1), target_addr, data_size)); |
| 97 | + TEST_ESP_OK(part_blockdev_2->ops->read(part_blockdev_2, data_buffer_2, sizeof(data_buffer_2), target_addr, data_size)); |
| 98 | + TEST_ASSERT_EQUAL(0, memcmp(test_data, data_buffer_1, data_size)); |
| 99 | + TEST_ASSERT_EQUAL(0, memcmp(test_data, data_buffer_2, data_size)); |
| 100 | + |
| 101 | + //write to the blockdev 1 |
| 102 | + memset((void*)test_data, 'A', data_size); |
| 103 | + TEST_ESP_OK(part_blockdev_1->ops->write(part_blockdev_1, test_data, target_addr, data_size)); |
| 104 | + |
| 105 | + //read the data written before from the blockdev 1 |
| 106 | + TEST_ESP_OK(part_blockdev_1->ops->read(part_blockdev_1, data_buffer_1, sizeof(data_buffer_1), target_addr, data_size)); |
| 107 | + TEST_ASSERT_EQUAL(0, memcmp(test_data, data_buffer_1, data_size)); |
| 108 | + |
| 109 | + //write to the blockdev 2 |
| 110 | + memset((void*)test_data, 'B', data_size); |
| 111 | + TEST_ESP_OK(part_blockdev_2->ops->write(part_blockdev_2, test_data, target_addr, data_size)); |
| 112 | + |
| 113 | + //read the data written before from the blockdev 2 |
| 114 | + TEST_ESP_OK(part_blockdev_2->ops->read(part_blockdev_2, data_buffer_2, sizeof(data_buffer_2), target_addr, data_size)); |
| 115 | + TEST_ASSERT_EQUAL(0, memcmp(test_data, data_buffer_2, data_size)); |
| 116 | + |
| 117 | + //release the BDL objects |
| 118 | + TEST_ESP_OK(part_blockdev_1->ops->release(part_blockdev_1)); |
| 119 | + TEST_ESP_OK(part_blockdev_2->ops->release(part_blockdev_2)); |
| 120 | +} |
| 121 | + |
| 122 | +TEST(partition_bdl, test_partition_bdl_limits) |
| 123 | +{ |
| 124 | + // Limits tested: |
| 125 | + // - geometry alignment with parameter size for all ops |
| 126 | + // - dst buffer size check when reading |
| 127 | + // Partition boundaries and other checks are provided by underlying partition APIs and are not verified here |
| 128 | + |
| 129 | + esp_blockdev_handle_t part_blockdev = NULL; |
| 130 | + TEST_ESP_OK(esp_partition_get_blockdev(ESP_PARTITION_TYPE_DATA, ESP_PARTITION_SUBTYPE_ANY, "storage1", &part_blockdev)); |
| 131 | + |
| 132 | + //artifitial setup setup for this test only |
| 133 | + part_blockdev->geometry.erase_size = 512; |
| 134 | + part_blockdev->geometry.read_size = 4; |
| 135 | + part_blockdev->geometry.write_size = 16; |
| 136 | + |
| 137 | + const size_t data_size = part_blockdev->geometry.erase_size; |
| 138 | + uint8_t test_data[data_size]; |
| 139 | + uint8_t test_data_err[data_size-3]; |
| 140 | + const off_t target_addr_err = 3; |
| 141 | + |
| 142 | + //correct addr, wrong length |
| 143 | + TEST_ASSERT_EQUAL(ESP_ERR_INVALID_SIZE, part_blockdev->ops->erase(part_blockdev, 0, data_size+3)); |
| 144 | + //wrong addr, correct length |
| 145 | + TEST_ASSERT_EQUAL(ESP_ERR_INVALID_SIZE, part_blockdev->ops->erase(part_blockdev, target_addr_err, part_blockdev->geometry.erase_size)); |
| 146 | + |
| 147 | + //correct addr, correct dst buff, wrong length |
| 148 | + TEST_ASSERT_EQUAL(ESP_ERR_INVALID_SIZE, part_blockdev->ops->read(part_blockdev, test_data, data_size, 0, data_size+3)); |
| 149 | + //wrong addr, correct dst buff, correct length |
| 150 | + TEST_ASSERT_EQUAL(ESP_ERR_INVALID_SIZE, part_blockdev->ops->read(part_blockdev, test_data, data_size, target_addr_err, data_size)); |
| 151 | + //correct addr, wrong dst buff, correct length |
| 152 | + TEST_ASSERT_EQUAL(ESP_ERR_INVALID_ARG, part_blockdev->ops->read(part_blockdev, test_data_err, sizeof(test_data_err), 0, data_size)); |
| 153 | + |
| 154 | + //correct addr, wrong length |
| 155 | + TEST_ASSERT_EQUAL(ESP_ERR_INVALID_SIZE, part_blockdev->ops->write(part_blockdev, test_data, 0, data_size+3)); |
| 156 | + //wrong addr, correct length |
| 157 | + TEST_ASSERT_EQUAL(ESP_ERR_INVALID_SIZE, part_blockdev->ops->write(part_blockdev, test_data, target_addr_err, data_size)); |
| 158 | + |
| 159 | + //release the BDL objects |
| 160 | + TEST_ESP_OK(part_blockdev->ops->release(part_blockdev)); |
| 161 | +} |
| 162 | + |
| 163 | +TEST(partition_bdl, test_bdl_partition_readonly) |
| 164 | +{ |
| 165 | + //storage3 is readonly partition |
| 166 | + esp_blockdev_handle_t part_blockdev = NULL; |
| 167 | + TEST_ESP_OK(esp_partition_get_blockdev(ESP_PARTITION_TYPE_DATA, ESP_PARTITION_SUBTYPE_ANY, "storage3", &part_blockdev)); |
| 168 | + |
| 169 | + //test flags |
| 170 | + TEST_ASSERT_EQUAL(1, part_blockdev->device_flags.read_only); |
| 171 | + TEST_ASSERT_EQUAL(0, part_blockdev->geometry.write_size); |
| 172 | + TEST_ASSERT_EQUAL(0, part_blockdev->geometry.erase_size); |
| 173 | + TEST_ASSERT_EQUAL(0, part_blockdev->geometry.recommended_write_size); |
| 174 | + TEST_ASSERT_EQUAL(0, part_blockdev->geometry.recommended_erase_size); |
| 175 | + |
| 176 | + uint8_t dummy_test_buff[1024]; |
| 177 | + |
| 178 | + //write & erase must fail and read must work normally |
| 179 | + TEST_ASSERT_EQUAL(ESP_ERR_NOT_SUPPORTED, part_blockdev->ops->erase(part_blockdev, 0, sizeof(dummy_test_buff))); |
| 180 | + TEST_ASSERT_EQUAL(ESP_ERR_NOT_SUPPORTED, part_blockdev->ops->write(part_blockdev, dummy_test_buff, 0, sizeof(dummy_test_buff))); |
| 181 | + TEST_ESP_OK(part_blockdev->ops->read(part_blockdev, dummy_test_buff, sizeof(dummy_test_buff), 0, sizeof(dummy_test_buff))); |
| 182 | + |
| 183 | + TEST_ESP_OK(part_blockdev->ops->release(part_blockdev)); |
| 184 | +} |
| 185 | + |
| 186 | +TEST_GROUP_RUNNER(partition_bdl) |
| 187 | +{ |
| 188 | + RUN_TEST_CASE(partition_bdl, test_partition_bdl_ops); |
| 189 | + RUN_TEST_CASE(partition_bdl, test_two_partitions_bdl_ops); |
| 190 | + RUN_TEST_CASE(partition_bdl, test_partition_bdl_limits); |
| 191 | + RUN_TEST_CASE(partition_bdl, test_bdl_partition_readonly); |
| 192 | +} |
| 193 | + |
| 194 | +static void run_all_tests(void) |
| 195 | +{ |
| 196 | + RUN_TEST_GROUP(partition_bdl); |
| 197 | +} |
| 198 | + |
| 199 | +int main(int argc, char **argv) |
| 200 | +{ |
| 201 | + UNITY_MAIN_FUNC(run_all_tests); |
| 202 | + return 0; |
| 203 | +} |
0 commit comments