|
| 1 | +/* |
| 2 | + * This file is part of the MicroPython project, http://micropython.org/ |
| 3 | + * |
| 4 | + * The MIT License (MIT) |
| 5 | + * |
| 6 | + * Copyright (c) 2024 OpenMV LLC. |
| 7 | + * |
| 8 | + * Permission is hereby granted, free of charge, to any person obtaining a copy |
| 9 | + * of this software and associated documentation files (the "Software"), to deal |
| 10 | + * in the Software without restriction, including without limitation the rights |
| 11 | + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| 12 | + * copies of the Software, and to permit persons to whom the Software is |
| 13 | + * furnished to do so, subject to the following conditions: |
| 14 | + * |
| 15 | + * The above copyright notice and this permission notice shall be included in |
| 16 | + * all copies or substantial portions of the Software. |
| 17 | + * |
| 18 | + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 19 | + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 20 | + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 21 | + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 22 | + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 23 | + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
| 24 | + * THE SOFTWARE. |
| 25 | + */ |
| 26 | + |
| 27 | +#include <stdio.h> |
| 28 | +#include <string.h> |
| 29 | + |
| 30 | +#include "irq.h" |
| 31 | +#include "se_services.h" |
| 32 | + |
| 33 | +#include "mhu.h" |
| 34 | +#include "services_lib_bare_metal.h" |
| 35 | +#include "services_lib_protocol.h" |
| 36 | + |
| 37 | +#include "py/mphal.h" |
| 38 | + |
| 39 | +// MHU indices. |
| 40 | +#define MHU_M55_SE_MHU0 0 |
| 41 | +#define MAX_MHU 1 |
| 42 | + |
| 43 | +// The following timeout is implemented in se_services_handle.c as a |
| 44 | +// simple loop busy polling on a variable set from an IRQ. |
| 45 | +#define TIMEOUT 10000000 |
| 46 | + |
| 47 | +typedef struct { |
| 48 | + volatile unsigned int RST_CTRL; // 0x1A010318 |
| 49 | + volatile unsigned int RST_STAT; // 0x1A01031C |
| 50 | +} CPU_Type; |
| 51 | + |
| 52 | +// HE CPU register flags |
| 53 | +#define RST_CTRL_CPUWAIT_MASK (1 << 0) |
| 54 | +#define RST_CTRL_RST_REQ_MASK (1 << 1) |
| 55 | +#define RST_STAT_RST_ACK_MASK (3 << 1) |
| 56 | +#define HE_CPU ((CPU_Type *)0x1A010318) |
| 57 | + |
| 58 | +static const uint32_t mhu_sender_base_address_list[MAX_MHU] = { |
| 59 | + MHU_SESS_S_TX_BASE, |
| 60 | +}; |
| 61 | + |
| 62 | +static const uint32_t mhu_receiver_base_address_list[MAX_MHU] = { |
| 63 | + MHU_SESS_S_RX_BASE, |
| 64 | +}; |
| 65 | + |
| 66 | +// Must be aligned as a uint32_t. |
| 67 | +static uint32_t packet_buffer[SERVICES_MAX_PACKET_BUFFER_SIZE / sizeof(uint32_t)]; |
| 68 | + |
| 69 | +static mhu_driver_out_t mhu_driver_out; |
| 70 | +static uint32_t se_services_handle; |
| 71 | + |
| 72 | +void MHU_SESS_S_TX_IRQHandler(void) { |
| 73 | + mhu_driver_out.sender_irq_handler(MHU_M55_SE_MHU0); |
| 74 | +} |
| 75 | + |
| 76 | +void MHU_SESS_S_RX_IRQHandler(void) { |
| 77 | + mhu_driver_out.receiver_irq_handler(MHU_M55_SE_MHU0); |
| 78 | +} |
| 79 | + |
| 80 | +int dummy_printf(const char *fmt, ...) { |
| 81 | + (void)fmt; |
| 82 | + return 0; |
| 83 | +} |
| 84 | + |
| 85 | +void se_services_init(void) { |
| 86 | + // Initialize MHU. |
| 87 | + mhu_driver_in_t mhu_driver_in; |
| 88 | + mhu_driver_in.sender_base_address_list = (uint32_t *)mhu_sender_base_address_list; |
| 89 | + mhu_driver_in.receiver_base_address_list = (uint32_t *)mhu_receiver_base_address_list; |
| 90 | + mhu_driver_in.mhu_count = MAX_MHU; |
| 91 | + mhu_driver_in.send_msg_acked_callback = SERVICES_send_msg_acked_callback; |
| 92 | + mhu_driver_in.rx_msg_callback = SERVICES_rx_msg_callback; |
| 93 | + mhu_driver_in.debug_print = NULL; // not currently used by MHU_driver_initialize |
| 94 | + MHU_driver_initialize(&mhu_driver_in, &mhu_driver_out); |
| 95 | + |
| 96 | + // Initialize SE services. |
| 97 | + services_lib_t services_init_params = { |
| 98 | + .packet_buffer_address = (uint32_t)packet_buffer, |
| 99 | + .fn_send_mhu_message = mhu_driver_out.send_message, |
| 100 | + .fn_wait_ms = NULL, // not currently used by services_host_handler.c |
| 101 | + .wait_timeout = TIMEOUT, |
| 102 | + .fn_print_msg = dummy_printf, |
| 103 | + }; |
| 104 | + SERVICES_initialize(&services_init_params); |
| 105 | + |
| 106 | + // Create SE services channel for sending requests. |
| 107 | + se_services_handle = SERVICES_register_channel(MHU_M55_SE_MHU0, 0); |
| 108 | + |
| 109 | + // Enable MHU interrupts. |
| 110 | + NVIC_ClearPendingIRQ(MHU_SESS_S_RX_IRQ_IRQn); |
| 111 | + NVIC_SetPriority(MHU_SESS_S_RX_IRQ_IRQn, IRQ_PRI_MHU); |
| 112 | + NVIC_EnableIRQ(MHU_SESS_S_RX_IRQ_IRQn); |
| 113 | + NVIC_ClearPendingIRQ(MHU_SESS_S_TX_IRQ_IRQn); |
| 114 | + NVIC_SetPriority(MHU_SESS_S_TX_IRQ_IRQn, IRQ_PRI_MHU); |
| 115 | + NVIC_EnableIRQ(MHU_SESS_S_TX_IRQ_IRQn); |
| 116 | + |
| 117 | + // Send heartbeat services requests until one succeeds. |
| 118 | + SERVICES_synchronize_with_se(se_services_handle); |
| 119 | +} |
| 120 | + |
| 121 | +void se_services_dump_device_data(void) { |
| 122 | + uint32_t error_code; |
| 123 | + |
| 124 | + uint8_t revision[80]; |
| 125 | + SERVICES_get_se_revision(se_services_handle, revision, &error_code); |
| 126 | + |
| 127 | + SERVICES_version_data_t data; |
| 128 | + SERVICES_system_get_device_data(se_services_handle, &data, &error_code); |
| 129 | + |
| 130 | + printf("SE revision: %s\n", revision); |
| 131 | + printf("ALIF_PN: %s\n", data.ALIF_PN); |
| 132 | + printf("Raw device data:\n"); |
| 133 | + for (int i = 0; i < sizeof(data); ++i) { |
| 134 | + printf(" %02x", ((uint8_t *)&data)[i]); |
| 135 | + if (i % 16 == 15) { |
| 136 | + printf("\n"); |
| 137 | + } |
| 138 | + } |
| 139 | + printf("\n"); |
| 140 | +} |
| 141 | + |
| 142 | +void se_services_get_unique_id(uint8_t id[5]) { |
| 143 | + uint32_t error_code; |
| 144 | + SERVICES_version_data_t data; |
| 145 | + SERVICES_system_get_device_data(se_services_handle, &data, &error_code); |
| 146 | + // The MfgData has 5 bytes of valid data, at least on REV_B2. |
| 147 | + memcpy(id, data.MfgData, 5); |
| 148 | +} |
| 149 | + |
| 150 | +__attribute__((noreturn)) void se_services_reset_soc(void) { |
| 151 | + SERVICES_boot_reset_soc(se_services_handle); |
| 152 | + NVIC_SystemReset(); |
| 153 | +} |
| 154 | + |
| 155 | +uint64_t se_services_rand64(void) { |
| 156 | + // If the SE core is not ready then the return value can be |
| 157 | + // SERVICES_REQ_NOT_ACKNOWLEDGE. So retry a few times. |
| 158 | + for (int retry = 0; retry < 100; ++retry) { |
| 159 | + uint64_t value; |
| 160 | + int32_t error_code; |
| 161 | + uint32_t ret = SERVICES_cryptocell_get_rnd(se_services_handle, sizeof(uint64_t), &value, &error_code); |
| 162 | + if (ret == SERVICES_REQ_SUCCESS) { |
| 163 | + return value; |
| 164 | + } |
| 165 | + } |
| 166 | + |
| 167 | + // No random number available. |
| 168 | + return 0; |
| 169 | +} |
| 170 | + |
| 171 | +uint32_t se_services_enable_clock(clock_enable_t clock, bool enable) { |
| 172 | + uint32_t error_code; |
| 173 | + SERVICES_clocks_enable_clock(se_services_handle, clock, enable, &error_code); |
| 174 | + return error_code; |
| 175 | +} |
| 176 | + |
| 177 | +uint32_t se_services_select_pll_source(pll_source_t source, pll_target_t target) { |
| 178 | + uint32_t error_code; |
| 179 | + SERVICES_clocks_select_pll_source(se_services_handle, source, target, &error_code); |
| 180 | + return error_code; |
| 181 | +} |
| 182 | + |
| 183 | +uint32_t se_services_get_run_profile(run_profile_t *profile) { |
| 184 | + uint32_t error_code; |
| 185 | + SERVICES_get_run_cfg(se_services_handle, profile, &error_code); |
| 186 | + return error_code; |
| 187 | +} |
| 188 | + |
| 189 | +uint32_t se_services_set_run_profile(run_profile_t *profile) { |
| 190 | + uint32_t error_code; |
| 191 | + SERVICES_set_run_cfg(se_services_handle, profile, &error_code); |
| 192 | + return error_code; |
| 193 | +} |
| 194 | + |
| 195 | +uint32_t se_services_get_off_profile(off_profile_t *profile) { |
| 196 | + uint32_t error_code; |
| 197 | + SERVICES_get_off_cfg(se_services_handle, profile, &error_code); |
| 198 | + return error_code; |
| 199 | +} |
| 200 | + |
| 201 | +uint32_t se_services_set_off_profile(off_profile_t *profile) { |
| 202 | + uint32_t error_code; |
| 203 | + SERVICES_set_off_cfg(se_services_handle, profile, &error_code); |
| 204 | + return error_code; |
| 205 | +} |
| 206 | + |
| 207 | +uint32_t se_services_boot_process_toc_entry(const uint8_t *image_id) { |
| 208 | + uint32_t error_code; |
| 209 | + SERVICES_boot_process_toc_entry(se_services_handle, image_id, &error_code); |
| 210 | + return error_code; |
| 211 | +} |
| 212 | + |
| 213 | +uint32_t se_services_boot_cpu(uint32_t cpu_id, uint32_t address) { |
| 214 | + uint32_t error_code; |
| 215 | + SERVICES_boot_cpu(se_services_handle, cpu_id, address, &error_code); |
| 216 | + return error_code; |
| 217 | +} |
| 218 | + |
| 219 | +uint32_t se_services_boot_reset_cpu(uint32_t cpu_id) { |
| 220 | + uint32_t error_code; |
| 221 | + if (HE_CPU->RST_CTRL & RST_CTRL_CPUWAIT_MASK) { |
| 222 | + // CPU held in reset |
| 223 | + return SERVICES_REQ_SUCCESS; |
| 224 | + } |
| 225 | + |
| 226 | + for (mp_uint_t start = mp_hal_ticks_ms(); ; mp_hal_delay_ms(1)) { |
| 227 | + uint32_t ret = SERVICES_boot_reset_cpu(se_services_handle, cpu_id, &error_code); |
| 228 | + if (ret != SERVICES_REQ_SUCCESS) { |
| 229 | + return error_code; |
| 230 | + } |
| 231 | + |
| 232 | + if ((HE_CPU->RST_STAT & RST_STAT_RST_ACK_MASK) == 0x4) { |
| 233 | + return SERVICES_REQ_SUCCESS; |
| 234 | + } |
| 235 | + |
| 236 | + if ((mp_hal_ticks_ms() - start) >= 100) { |
| 237 | + return SERVICES_REQ_TIMEOUT; |
| 238 | + } |
| 239 | + } |
| 240 | + return error_code; |
| 241 | +} |
| 242 | + |
| 243 | +uint32_t se_services_boot_release_cpu(uint32_t cpu_id) { |
| 244 | + uint32_t error_code; |
| 245 | + SERVICES_boot_release_cpu(se_services_handle, cpu_id, &error_code); |
| 246 | + return error_code; |
| 247 | +} |
0 commit comments