1 /*
2 * Copyright (c) 2018 Nordic Semiconductor ASA
3 * Copyright (c) 2015 Runtime Inc
4 *
5 * SPDX-License-Identifier: Apache-2.0
6 */
7
8 #include <zephyr/kernel.h>
9 #include <zephyr/devicetree.h>
10 #include <zephyr/drivers/flash.h>
11
12 #include "target.h"
13
14 #include <flash_map_backend/flash_map_backend.h>
15 #include <sysflash/sysflash.h>
16
17 #include "bootutil/bootutil_log.h"
18
19 BOOT_LOG_MODULE_DECLARE(mcuboot);
20
21 #if (!defined(CONFIG_XTENSA) && DT_HAS_CHOSEN(zephyr_flash_controller))
22 #define FLASH_DEVICE_ID SOC_FLASH_0_ID
23 #define FLASH_DEVICE_BASE CONFIG_FLASH_BASE_ADDRESS
24 #define FLASH_DEVICE_NODE DT_CHOSEN(zephyr_flash_controller)
25
26 #elif (defined(CONFIG_XTENSA) && DT_NODE_EXISTS(DT_INST(0, jedec_spi_nor)))
27 #define FLASH_DEVICE_ID SPI_FLASH_0_ID
28 #define FLASH_DEVICE_BASE 0
29 #define FLASH_DEVICE_NODE DT_INST(0, jedec_spi_nor)
30
31 #elif defined(CONFIG_SOC_FAMILY_ESPRESSIF_ESP32)
32
33 #define FLASH_DEVICE_ID SPI_FLASH_0_ID
34 #define FLASH_DEVICE_BASE 0
35 #define FLASH_DEVICE_NODE DT_CHOSEN(zephyr_flash_controller)
36
37 #else
38 #error "FLASH_DEVICE_ID could not be determined"
39 #endif
40
41 static const struct device *flash_dev = DEVICE_DT_GET(FLASH_DEVICE_NODE);
42
flash_device_base(uint8_t fd_id,uintptr_t * ret)43 int flash_device_base(uint8_t fd_id, uintptr_t *ret)
44 {
45 if (fd_id != FLASH_DEVICE_ID) {
46 BOOT_LOG_ERR("invalid flash ID %d; expected %d",
47 fd_id, FLASH_DEVICE_ID);
48 return -EINVAL;
49 }
50 *ret = FLASH_DEVICE_BASE;
51 return 0;
52 }
53
54 /*
55 * This depends on the mappings defined in sysflash.h.
56 * MCUBoot uses continuous numbering for the primary slot, the secondary slot,
57 * and the scratch while zephyr might number it differently.
58 */
flash_area_id_from_multi_image_slot(int image_index,int slot)59 int flash_area_id_from_multi_image_slot(int image_index, int slot)
60 {
61 switch (slot) {
62 case 0: return FLASH_AREA_IMAGE_PRIMARY(image_index);
63 #if !defined(CONFIG_SINGLE_APPLICATION_SLOT)
64 case 1: return FLASH_AREA_IMAGE_SECONDARY(image_index);
65 #endif
66 #if defined(CONFIG_BOOT_SWAP_USING_SCRATCH)
67 case 2: return FLASH_AREA_IMAGE_SCRATCH;
68 #endif
69 }
70
71 return -EINVAL; /* flash_area_open will fail on that */
72 }
73
flash_area_id_from_image_slot(int slot)74 int flash_area_id_from_image_slot(int slot)
75 {
76 return flash_area_id_from_multi_image_slot(0, slot);
77 }
78
flash_area_id_to_multi_image_slot(int image_index,int area_id)79 int flash_area_id_to_multi_image_slot(int image_index, int area_id)
80 {
81 if (area_id == FLASH_AREA_IMAGE_PRIMARY(image_index)) {
82 return 0;
83 }
84 #if !defined(CONFIG_SINGLE_APPLICATION_SLOT)
85 if (area_id == FLASH_AREA_IMAGE_SECONDARY(image_index)) {
86 return 1;
87 }
88 #endif
89
90 BOOT_LOG_ERR("invalid flash area ID");
91 return -1;
92 }
93
94 #if defined(CONFIG_MCUBOOT_SERIAL_DIRECT_IMAGE_UPLOAD)
flash_area_id_from_direct_image(int image_id)95 int flash_area_id_from_direct_image(int image_id)
96 {
97 switch (image_id) {
98 case 0:
99 case 1:
100 return FIXED_PARTITION_ID(slot0_partition);
101 #if FIXED_PARTITION_EXISTS(slot1_partition)
102 case 2:
103 return FIXED_PARTITION_ID(slot1_partition);
104 #endif
105 #if FIXED_PARTITION_EXISTS(slot2_partition)
106 case 3:
107 return FIXED_PARTITION_ID(slot2_partition);
108 #endif
109 #if FIXED_PARTITION_EXISTS(slot3_partition)
110 case 4:
111 return FIXED_PARTITION_ID(slot3_partition);
112 #endif
113 #if FIXED_PARTITION_EXISTS(slot4_partition)
114 case 5:
115 return FIXED_PARTITION_ID(slot4_partition);
116 #endif
117 #if FIXED_PARTITION_EXISTS(slot5_partition)
118 case 6:
119 return FIXED_PARTITION_ID(slot5_partition);
120 #endif
121 }
122 return -EINVAL;
123 }
124 #endif
125
flash_area_sector_from_off(off_t off,struct flash_sector * sector)126 int flash_area_sector_from_off(off_t off, struct flash_sector *sector)
127 {
128 int rc;
129 struct flash_pages_info page;
130
131 rc = flash_get_page_info_by_offs(flash_dev, off, &page);
132 if (rc) {
133 return rc;
134 }
135
136 sector->fs_off = page.start_offset;
137 sector->fs_size = page.size;
138
139 return rc;
140 }
141
flash_area_get_device_id(const struct flash_area * fa)142 uint8_t flash_area_get_device_id(const struct flash_area *fa)
143 {
144 #if defined(CONFIG_ARM)
145 return fa->fa_id;
146 #else
147 (void)fa;
148 return FLASH_DEVICE_ID;
149 #endif
150 }
151
152 #define ERASED_VAL 0xff
flash_area_erased_val(const struct flash_area * fap)153 __weak uint8_t flash_area_erased_val(const struct flash_area *fap)
154 {
155 (void)fap;
156 return ERASED_VAL;
157 }
158
flash_area_get_sector(const struct flash_area * fap,off_t off,struct flash_sector * fsp)159 int flash_area_get_sector(const struct flash_area *fap, off_t off,
160 struct flash_sector *fsp)
161 {
162 struct flash_pages_info fpi;
163 int rc;
164
165 if (off >= fap->fa_size) {
166 return -ERANGE;
167 }
168
169 rc = flash_get_page_info_by_offs(fap->fa_dev, fap->fa_off + off,
170 &fpi);
171
172 if (rc == 0) {
173 fsp->fs_off = fpi.start_offset - fap->fa_off;
174 fsp->fs_size = fpi.size;
175 }
176
177 return rc;
178 }
179
