Kristofer Jonsson | 49bdee8 | 2020-04-06 13:21:21 +0200 | [diff] [blame] | 1 | /* |
Jonny Svärd | 4140d66 | 2024-04-17 18:02:15 +0200 | [diff] [blame^] | 2 | * SPDX-FileCopyrightText: Copyright 2019-2024 Arm Limited and/or its affiliates <open-source-office@arm.com> |
Kristofer Jonsson | 49bdee8 | 2020-04-06 13:21:21 +0200 | [diff] [blame] | 3 | * SPDX-License-Identifier: Apache-2.0 |
| 4 | * |
| 5 | * Licensed under the Apache License, Version 2.0 (the License); you may |
| 6 | * not use this file except in compliance with the License. |
| 7 | * You may obtain a copy of the License at |
| 8 | * |
| 9 | * www.apache.org/licenses/LICENSE-2.0 |
| 10 | * |
| 11 | * Unless required by applicable law or agreed to in writing, software |
| 12 | * distributed under the License is distributed on an AS IS BASIS, WITHOUT |
| 13 | * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 14 | * See the License for the specific language governing permissions and |
| 15 | * limitations under the License. |
| 16 | */ |
| 17 | |
Kristofer Jonsson | 3c43917 | 2020-08-05 09:38:40 +0200 | [diff] [blame] | 18 | #ifndef ETHOSU_DRIVER_H |
| 19 | #define ETHOSU_DRIVER_H |
Kristofer Jonsson | 49bdee8 | 2020-04-06 13:21:21 +0200 | [diff] [blame] | 20 | |
| 21 | /****************************************************************************** |
| 22 | * Includes |
| 23 | ******************************************************************************/ |
| 24 | |
Jonny Svärd | 136810f | 2021-10-13 16:04:26 +0200 | [diff] [blame] | 25 | #include "ethosu_types.h" |
Bhavik Patel | dae5be0 | 2020-06-18 15:25:15 +0200 | [diff] [blame] | 26 | |
| 27 | #include <stdbool.h> |
Kristofer Jonsson | 2b201c3 | 2020-09-02 16:42:43 +0200 | [diff] [blame] | 28 | #include <stddef.h> |
Kristofer Jonsson | 49bdee8 | 2020-04-06 13:21:21 +0200 | [diff] [blame] | 29 | #include <stdint.h> |
| 30 | |
| 31 | #ifdef __cplusplus |
| 32 | extern "C" { |
| 33 | #endif |
| 34 | |
| 35 | /****************************************************************************** |
Jonny Svärd | a830f17 | 2021-06-07 16:57:00 +0200 | [diff] [blame] | 36 | * Defines |
| 37 | ******************************************************************************/ |
| 38 | |
| 39 | #define ETHOSU_DRIVER_VERSION_MAJOR 0 ///< Driver major version |
| 40 | #define ETHOSU_DRIVER_VERSION_MINOR 16 ///< Driver minor version |
| 41 | #define ETHOSU_DRIVER_VERSION_PATCH 0 ///< Driver patch version |
| 42 | |
Jonny Svärd | a2732ec | 2023-12-18 17:19:15 +0100 | [diff] [blame] | 43 | #define ETHOSU_SEMAPHORE_WAIT_FOREVER (UINT64_MAX) |
| 44 | |
| 45 | #ifndef ETHOSU_SEMAPHORE_WAIT_INFERENCE |
| 46 | #define ETHOSU_SEMAPHORE_WAIT_INFERENCE ETHOSU_SEMAPHORE_WAIT_FOREVER |
| 47 | #endif |
| 48 | |
Jonny Svärd | a830f17 | 2021-06-07 16:57:00 +0200 | [diff] [blame] | 49 | /****************************************************************************** |
Kristofer Jonsson | 49bdee8 | 2020-04-06 13:21:21 +0200 | [diff] [blame] | 50 | * Types |
| 51 | ******************************************************************************/ |
| 52 | |
Jonny Svärd | 136810f | 2021-10-13 16:04:26 +0200 | [diff] [blame] | 53 | // Forward declare |
| 54 | struct ethosu_device; |
| 55 | |
Jonny Svärd | 1a3bb92 | 2022-02-25 16:28:21 +0100 | [diff] [blame] | 56 | enum ethosu_job_state |
| 57 | { |
| 58 | ETHOSU_JOB_IDLE = 0, |
| 59 | ETHOSU_JOB_RUNNING, |
| 60 | ETHOSU_JOB_DONE |
| 61 | }; |
| 62 | |
Jonny Svärd | a2732ec | 2023-12-18 17:19:15 +0100 | [diff] [blame] | 63 | enum ethosu_job_result |
| 64 | { |
| 65 | ETHOSU_JOB_RESULT_OK = 0, |
| 66 | ETHOSU_JOB_RESULT_TIMEOUT, |
| 67 | ETHOSU_JOB_RESULT_ERROR |
| 68 | }; |
| 69 | |
Jonny Svärd | 1a3bb92 | 2022-02-25 16:28:21 +0100 | [diff] [blame] | 70 | struct ethosu_job |
| 71 | { |
| 72 | volatile enum ethosu_job_state state; |
Jonny Svärd | a2732ec | 2023-12-18 17:19:15 +0100 | [diff] [blame] | 73 | volatile enum ethosu_job_result result; |
Jonny Svärd | 1a3bb92 | 2022-02-25 16:28:21 +0100 | [diff] [blame] | 74 | const void *custom_data_ptr; |
| 75 | int custom_data_size; |
| 76 | const uint64_t *base_addr; |
| 77 | const size_t *base_addr_size; |
| 78 | int num_base_addr; |
| 79 | void *user_arg; |
| 80 | }; |
| 81 | |
Bhavik Patel | dae5be0 | 2020-06-18 15:25:15 +0200 | [diff] [blame] | 82 | struct ethosu_driver |
| 83 | { |
Jonny Svärd | 136810f | 2021-10-13 16:04:26 +0200 | [diff] [blame] | 84 | struct ethosu_device *dev; |
Jonny Svärd | a830f17 | 2021-06-07 16:57:00 +0200 | [diff] [blame] | 85 | struct ethosu_driver *next; |
Jonny Svärd | 1a3bb92 | 2022-02-25 16:28:21 +0100 | [diff] [blame] | 86 | struct ethosu_job job; |
Jonny Svärd | a830f17 | 2021-06-07 16:57:00 +0200 | [diff] [blame] | 87 | void *semaphore; |
Kristofer Jonsson | 2b201c3 | 2020-09-02 16:42:43 +0200 | [diff] [blame] | 88 | uint64_t fast_memory; |
| 89 | size_t fast_memory_size; |
Jonny Svärd | 301399d | 2022-04-26 18:31:24 +0200 | [diff] [blame] | 90 | uint32_t power_request_counter; |
Anton Moberg | 61da4d3 | 2020-12-22 16:00:31 +0100 | [diff] [blame] | 91 | bool reserved; |
Bhavik Patel | dae5be0 | 2020-06-18 15:25:15 +0200 | [diff] [blame] | 92 | }; |
| 93 | |
Jonny Svärd | a830f17 | 2021-06-07 16:57:00 +0200 | [diff] [blame] | 94 | struct ethosu_driver_version |
Kristofer Jonsson | 49bdee8 | 2020-04-06 13:21:21 +0200 | [diff] [blame] | 95 | { |
Jonny Svärd | a830f17 | 2021-06-07 16:57:00 +0200 | [diff] [blame] | 96 | uint8_t major; |
| 97 | uint8_t minor; |
| 98 | uint8_t patch; |
Kristofer Jonsson | 49bdee8 | 2020-04-06 13:21:21 +0200 | [diff] [blame] | 99 | }; |
| 100 | |
Anton Moberg | 0a61429 | 2021-03-24 14:08:22 +0100 | [diff] [blame] | 101 | enum ethosu_request_clients |
| 102 | { |
| 103 | ETHOSU_PMU_REQUEST = 0, |
| 104 | ETHOSU_INFERENCE_REQUEST = 1, |
| 105 | }; |
| 106 | |
Kristofer Jonsson | 49bdee8 | 2020-04-06 13:21:21 +0200 | [diff] [blame] | 107 | /****************************************************************************** |
Jonny Svärd | a830f17 | 2021-06-07 16:57:00 +0200 | [diff] [blame] | 108 | * Prototypes (weak functions in driver) |
Kristofer Jonsson | 4dc73dc | 2020-10-16 12:33:47 +0200 | [diff] [blame] | 109 | ******************************************************************************/ |
| 110 | |
Jonny Svärd | a830f17 | 2021-06-07 16:57:00 +0200 | [diff] [blame] | 111 | /** |
| 112 | * Interrupt handler to be called on IRQ from Ethos-U |
Kristofer Jonsson | 68b5c91 | 2022-11-14 10:52:38 +0100 | [diff] [blame] | 113 | * |
| 114 | * @param drv Pointer to driver handle |
Jonny Svärd | a830f17 | 2021-06-07 16:57:00 +0200 | [diff] [blame] | 115 | */ |
| 116 | void ethosu_irq_handler(struct ethosu_driver *drv); |
| 117 | |
Kristofer Jonsson | 68b5c91 | 2022-11-14 10:52:38 +0100 | [diff] [blame] | 118 | /** |
Jonny Svärd | a830f17 | 2021-06-07 16:57:00 +0200 | [diff] [blame] | 119 | * Flush/clean the data cache by address and size. Passing NULL as p argument |
| 120 | * expects the whole cache to be flushed. |
Kristofer Jonsson | 68b5c91 | 2022-11-14 10:52:38 +0100 | [diff] [blame] | 121 | * |
| 122 | * Addresses passed to this function must be 16 byte aligned. |
| 123 | * |
| 124 | * @param p 16 byte aligned address |
| 125 | * @param bytes Size of memory block in bytes |
Jonny Svärd | a830f17 | 2021-06-07 16:57:00 +0200 | [diff] [blame] | 126 | */ |
Jonny Svärd | a830f17 | 2021-06-07 16:57:00 +0200 | [diff] [blame] | 127 | void ethosu_flush_dcache(uint32_t *p, size_t bytes); |
Kristofer Jonsson | 68b5c91 | 2022-11-14 10:52:38 +0100 | [diff] [blame] | 128 | |
| 129 | /** |
Jonny Svärd | a830f17 | 2021-06-07 16:57:00 +0200 | [diff] [blame] | 130 | * Invalidate the data cache by address and size. Passing NULL as p argument |
| 131 | * expects the whole cache to be invalidated. |
Kristofer Jonsson | 68b5c91 | 2022-11-14 10:52:38 +0100 | [diff] [blame] | 132 | * |
| 133 | * Addresses passed to this function must be 16 byte aligned. |
| 134 | * |
| 135 | * @param p 16 byte aligned address |
| 136 | * @param bytes Size in bytes |
Jonny Svärd | a830f17 | 2021-06-07 16:57:00 +0200 | [diff] [blame] | 137 | */ |
| 138 | void ethosu_invalidate_dcache(uint32_t *p, size_t bytes); |
| 139 | |
Kristofer Jonsson | 68b5c91 | 2022-11-14 10:52:38 +0100 | [diff] [blame] | 140 | /** |
| 141 | * Minimal mutex implementation for baremetal applications. See |
Jonny Svärd | a830f17 | 2021-06-07 16:57:00 +0200 | [diff] [blame] | 142 | * ethosu_driver.c. |
Kristofer Jonsson | 68b5c91 | 2022-11-14 10:52:38 +0100 | [diff] [blame] | 143 | * |
| 144 | * @return Pointer to mutex handle |
Jonny Svärd | a830f17 | 2021-06-07 16:57:00 +0200 | [diff] [blame] | 145 | */ |
| 146 | void *ethosu_mutex_create(void); |
Kristofer Jonsson | 68b5c91 | 2022-11-14 10:52:38 +0100 | [diff] [blame] | 147 | |
| 148 | /** |
Jonny Svärd | 4140d66 | 2024-04-17 18:02:15 +0200 | [diff] [blame^] | 149 | * Destroy mutex. |
| 150 | * |
| 151 | * @param mutex Pointer to mutex handle |
| 152 | */ |
| 153 | void ethosu_mutex_destroy(void *mutex); |
| 154 | |
| 155 | /** |
Kristofer Jonsson | 68b5c91 | 2022-11-14 10:52:38 +0100 | [diff] [blame] | 156 | * Minimal sempahore implementation for baremetal applications. See |
| 157 | * ethosu_driver.c. |
| 158 | * |
| 159 | * @return Pointer to semaphore handle |
| 160 | */ |
Jonny Svärd | a830f17 | 2021-06-07 16:57:00 +0200 | [diff] [blame] | 161 | void *ethosu_semaphore_create(void); |
Kristofer Jonsson | 68b5c91 | 2022-11-14 10:52:38 +0100 | [diff] [blame] | 162 | |
| 163 | /** |
Jonny Svärd | 4140d66 | 2024-04-17 18:02:15 +0200 | [diff] [blame^] | 164 | * Destroy semaphore. |
| 165 | * |
| 166 | * @param sem Pointer to semaphore handle |
| 167 | */ |
| 168 | void ethosu_semaphore_destroy(void *sem); |
| 169 | |
| 170 | /** |
Kristofer Jonsson | 68b5c91 | 2022-11-14 10:52:38 +0100 | [diff] [blame] | 171 | * Lock mutex. |
| 172 | * |
| 173 | * @param mutex Pointer to mutex handle |
| 174 | * @returns 0 on success, else negative error code |
Ledion Daja | c6505f3 | 2022-04-20 09:55:21 +0200 | [diff] [blame] | 175 | */ |
| 176 | int ethosu_mutex_lock(void *mutex); |
Kristofer Jonsson | 68b5c91 | 2022-11-14 10:52:38 +0100 | [diff] [blame] | 177 | |
| 178 | /** |
| 179 | * Unlock mutex. |
| 180 | * |
| 181 | * @param mutex Pointer to mutex handle |
| 182 | * @returns 0 on success, else negative error code |
| 183 | */ |
Ledion Daja | c6505f3 | 2022-04-20 09:55:21 +0200 | [diff] [blame] | 184 | int ethosu_mutex_unlock(void *mutex); |
Kristofer Jonsson | 68b5c91 | 2022-11-14 10:52:38 +0100 | [diff] [blame] | 185 | |
| 186 | /** |
| 187 | * Take semaphore. |
| 188 | * |
| 189 | * @param sem Pointer to semaphore handle |
Jonny Svärd | a2732ec | 2023-12-18 17:19:15 +0100 | [diff] [blame] | 190 | * @param timeout Timeout value (unit impl. defined) |
| 191 | * @returns 0 on success else negative error code |
Kristofer Jonsson | 68b5c91 | 2022-11-14 10:52:38 +0100 | [diff] [blame] | 192 | */ |
Jonny Svärd | a2732ec | 2023-12-18 17:19:15 +0100 | [diff] [blame] | 193 | int ethosu_semaphore_take(void *sem, uint64_t timeout); |
Kristofer Jonsson | 68b5c91 | 2022-11-14 10:52:38 +0100 | [diff] [blame] | 194 | |
| 195 | /** |
| 196 | * Give semaphore. |
| 197 | * |
| 198 | * @param sem Pointer to semaphore handle |
| 199 | * @returns 0 on success, else negative error code |
| 200 | */ |
Ledion Daja | c6505f3 | 2022-04-20 09:55:21 +0200 | [diff] [blame] | 201 | int ethosu_semaphore_give(void *sem); |
Jonny Svärd | a830f17 | 2021-06-07 16:57:00 +0200 | [diff] [blame] | 202 | |
Kristofer Jonsson | 68b5c91 | 2022-11-14 10:52:38 +0100 | [diff] [blame] | 203 | /** |
| 204 | * Callback invoked just before the inference is started. |
| 205 | * |
| 206 | * @param drv Pointer to driver handle |
| 207 | * @param user_arg User argument provided to ethosu_invoke_*() |
Jonny Svärd | a830f17 | 2021-06-07 16:57:00 +0200 | [diff] [blame] | 208 | */ |
Kristofer Jonsson | b3cde3c | 2022-01-27 17:30:15 +0100 | [diff] [blame] | 209 | void ethosu_inference_begin(struct ethosu_driver *drv, void *user_arg); |
Kristofer Jonsson | 68b5c91 | 2022-11-14 10:52:38 +0100 | [diff] [blame] | 210 | |
| 211 | /** |
| 212 | * Callback invoked just after the inference has completed. |
| 213 | * |
| 214 | * @param drv Pointer to driver handle |
| 215 | * @param user_arg User argument provided to ethosu_invoke_*() |
| 216 | */ |
Kristofer Jonsson | b3cde3c | 2022-01-27 17:30:15 +0100 | [diff] [blame] | 217 | void ethosu_inference_end(struct ethosu_driver *drv, void *user_arg); |
Kristofer Jonsson | 4dc73dc | 2020-10-16 12:33:47 +0200 | [diff] [blame] | 218 | |
Kristofer Jonsson | 9670332 | 2022-11-04 15:54:32 +0100 | [diff] [blame] | 219 | /** |
| 220 | * Remapping command stream and base pointer addresses. |
| 221 | * |
| 222 | * @param address Address to be remapped. |
Kristofer Jonsson | 68b5c91 | 2022-11-14 10:52:38 +0100 | [diff] [blame] | 223 | * @param index -1 command stream, 0-n base address index |
Kristofer Jonsson | 9670332 | 2022-11-04 15:54:32 +0100 | [diff] [blame] | 224 | * |
| 225 | * @return Remapped address |
| 226 | */ |
| 227 | uint64_t ethosu_address_remap(uint64_t address, int index); |
| 228 | |
Kristofer Jonsson | 4dc73dc | 2020-10-16 12:33:47 +0200 | [diff] [blame] | 229 | /****************************************************************************** |
Kristofer Jonsson | 49bdee8 | 2020-04-06 13:21:21 +0200 | [diff] [blame] | 230 | * Prototypes |
| 231 | ******************************************************************************/ |
| 232 | |
| 233 | /** |
| 234 | * Initialize the Ethos-U driver. |
Kristofer Jonsson | 68b5c91 | 2022-11-14 10:52:38 +0100 | [diff] [blame] | 235 | * |
| 236 | * @param drv Pointer to driver handle |
| 237 | * @param base_address NPU register base address |
| 238 | * @param fast_memory Fast memory area, used for Ethos-U65 with spilling |
| 239 | * @param fast_memory_size Size in bytes of fast memory area |
| 240 | * @param secure_enable Configure NPU in secure- or non-secure mode |
| 241 | * @param privilege_enable Configure NPU in privileged- or non-privileged mode |
| 242 | * @return 0 on success, else negative error code |
Kristofer Jonsson | 49bdee8 | 2020-04-06 13:21:21 +0200 | [diff] [blame] | 243 | */ |
Anton Moberg | effc7aa | 2021-05-03 09:25:06 +0200 | [diff] [blame] | 244 | int ethosu_init(struct ethosu_driver *drv, |
Ledion Daja | ecdce6c | 2023-01-16 15:39:29 +0100 | [diff] [blame] | 245 | void *const base_address, |
Anton Moberg | effc7aa | 2021-05-03 09:25:06 +0200 | [diff] [blame] | 246 | const void *fast_memory, |
| 247 | const size_t fast_memory_size, |
| 248 | uint32_t secure_enable, |
| 249 | uint32_t privilege_enable); |
Kristofer Jonsson | 49bdee8 | 2020-04-06 13:21:21 +0200 | [diff] [blame] | 250 | |
| 251 | /** |
Anton Moberg | 547ca53 | 2021-06-14 09:43:53 +0200 | [diff] [blame] | 252 | * Deinitialize the Ethos-U driver. |
Kristofer Jonsson | 68b5c91 | 2022-11-14 10:52:38 +0100 | [diff] [blame] | 253 | * |
| 254 | * @param drv Pointer to driver handle |
Anton Moberg | 547ca53 | 2021-06-14 09:43:53 +0200 | [diff] [blame] | 255 | */ |
| 256 | void ethosu_deinit(struct ethosu_driver *drv); |
| 257 | |
| 258 | /** |
Jonny Svärd | 301399d | 2022-04-26 18:31:24 +0200 | [diff] [blame] | 259 | * Soft resets the Ethos-U device. |
Kristofer Jonsson | 68b5c91 | 2022-11-14 10:52:38 +0100 | [diff] [blame] | 260 | * |
| 261 | * @param drv Pointer to driver handle |
| 262 | * @return 0 on success, else negative error code |
Jonny Svärd | 301399d | 2022-04-26 18:31:24 +0200 | [diff] [blame] | 263 | */ |
Kristofer Jonsson | 68b5c91 | 2022-11-14 10:52:38 +0100 | [diff] [blame] | 264 | int ethosu_soft_reset(struct ethosu_driver *drv); |
Jonny Svärd | 301399d | 2022-04-26 18:31:24 +0200 | [diff] [blame] | 265 | |
| 266 | /** |
| 267 | * Request to disable Q-channel power gating of the Ethos-U device. |
| 268 | * Power requests are ref.counted. Increases count. |
| 269 | * (Note: clock gating is made to follow power gating) |
Kristofer Jonsson | 68b5c91 | 2022-11-14 10:52:38 +0100 | [diff] [blame] | 270 | * |
| 271 | * @param drv Pointer to driver handle |
| 272 | * @return 0 on success, else negative error code |
Jonny Svärd | 301399d | 2022-04-26 18:31:24 +0200 | [diff] [blame] | 273 | */ |
Kristofer Jonsson | 68b5c91 | 2022-11-14 10:52:38 +0100 | [diff] [blame] | 274 | int ethosu_request_power(struct ethosu_driver *drv); |
Jonny Svärd | 301399d | 2022-04-26 18:31:24 +0200 | [diff] [blame] | 275 | |
| 276 | /** |
| 277 | * Release disable request for Q-channel power gating of the Ethos-U device. |
| 278 | * Power requests are ref.counted. Decreases count. |
Kristofer Jonsson | 68b5c91 | 2022-11-14 10:52:38 +0100 | [diff] [blame] | 279 | * |
| 280 | * @param drv Pointer to driver handle |
Jonny Svärd | 301399d | 2022-04-26 18:31:24 +0200 | [diff] [blame] | 281 | */ |
| 282 | void ethosu_release_power(struct ethosu_driver *drv); |
| 283 | |
| 284 | /** |
Jonny Svärd | a830f17 | 2021-06-07 16:57:00 +0200 | [diff] [blame] | 285 | * Get Ethos-U driver version. |
Kristofer Jonsson | 68b5c91 | 2022-11-14 10:52:38 +0100 | [diff] [blame] | 286 | * |
| 287 | * @param ver Driver version struct |
Kristofer Jonsson | 49bdee8 | 2020-04-06 13:21:21 +0200 | [diff] [blame] | 288 | */ |
Jonny Svärd | a830f17 | 2021-06-07 16:57:00 +0200 | [diff] [blame] | 289 | void ethosu_get_driver_version(struct ethosu_driver_version *ver); |
| 290 | |
| 291 | /** |
| 292 | * Get Ethos-U hardware information. |
Kristofer Jonsson | 68b5c91 | 2022-11-14 10:52:38 +0100 | [diff] [blame] | 293 | * |
| 294 | * @param drv Pointer to driver handle |
| 295 | * @param hw Hardware information struct |
Jonny Svärd | a830f17 | 2021-06-07 16:57:00 +0200 | [diff] [blame] | 296 | */ |
| 297 | void ethosu_get_hw_info(struct ethosu_driver *drv, struct ethosu_hw_info *hw); |
Kristofer Jonsson | 49bdee8 | 2020-04-06 13:21:21 +0200 | [diff] [blame] | 298 | |
| 299 | /** |
Kristofer Jonsson | 68b5c91 | 2022-11-14 10:52:38 +0100 | [diff] [blame] | 300 | * Invoke command stream. |
| 301 | * |
| 302 | * @param drv Pointer to driver handle |
| 303 | * @param custom_data_ptr Custom data payload |
| 304 | * @param custom_data_size Size in bytes of custom data |
| 305 | * @param base_addr Array of base address pointers |
| 306 | * @param base_addr_size Size in bytes of each address in base_addr |
| 307 | * @param num_base_addr Number of elements in base_addr array |
| 308 | * @param user_arg User argument, will be passed to |
| 309 | * ethosu_inference_begin() and ethosu_inference_end() |
| 310 | * @return 0 on success, else negative error code |
Kristofer Jonsson | 49bdee8 | 2020-04-06 13:21:21 +0200 | [diff] [blame] | 311 | */ |
Kristofer Jonsson | b3cde3c | 2022-01-27 17:30:15 +0100 | [diff] [blame] | 312 | int ethosu_invoke_v3(struct ethosu_driver *drv, |
| 313 | const void *custom_data_ptr, |
| 314 | const int custom_data_size, |
Ledion Daja | ecdce6c | 2023-01-16 15:39:29 +0100 | [diff] [blame] | 315 | uint64_t *const base_addr, |
Kristofer Jonsson | b3cde3c | 2022-01-27 17:30:15 +0100 | [diff] [blame] | 316 | const size_t *base_addr_size, |
| 317 | const int num_base_addr, |
| 318 | void *user_arg); |
| 319 | |
| 320 | #define ethosu_invoke(drv, custom_data_ptr, custom_data_size, base_addr, base_addr_size, num_base_addr) \ |
| 321 | ethosu_invoke_v3(drv, custom_data_ptr, custom_data_size, base_addr, base_addr_size, num_base_addr, 0) |
Kristofer Jonsson | 2b201c3 | 2020-09-02 16:42:43 +0200 | [diff] [blame] | 322 | |
Kristofer Jonsson | 49bdee8 | 2020-04-06 13:21:21 +0200 | [diff] [blame] | 323 | /** |
Kristofer Jonsson | 68b5c91 | 2022-11-14 10:52:38 +0100 | [diff] [blame] | 324 | * Invoke command stream using async interface. |
Jonny Svärd | 1a3bb92 | 2022-02-25 16:28:21 +0100 | [diff] [blame] | 325 | * Must be followed by call(s) to ethosu_wait() upon successful return. |
Kristofer Jonsson | 68b5c91 | 2022-11-14 10:52:38 +0100 | [diff] [blame] | 326 | * |
| 327 | * @see ethosu_invoke_v3 for documentation. |
Jonny Svärd | 1a3bb92 | 2022-02-25 16:28:21 +0100 | [diff] [blame] | 328 | */ |
| 329 | int ethosu_invoke_async(struct ethosu_driver *drv, |
| 330 | const void *custom_data_ptr, |
| 331 | const int custom_data_size, |
Ledion Daja | ecdce6c | 2023-01-16 15:39:29 +0100 | [diff] [blame] | 332 | uint64_t *const base_addr, |
Jonny Svärd | 1a3bb92 | 2022-02-25 16:28:21 +0100 | [diff] [blame] | 333 | const size_t *base_addr_size, |
| 334 | const int num_base_addr, |
| 335 | void *user_arg); |
| 336 | |
| 337 | /** |
| 338 | * Wait for inference to complete (block=true) |
| 339 | * Poll status or finish up if inference is complete (block=false) |
| 340 | * (This function is only intended to be used in conjuction with ethosu_invoke_async) |
Kristofer Jonsson | 68b5c91 | 2022-11-14 10:52:38 +0100 | [diff] [blame] | 341 | * |
| 342 | * @param drv Pointer to driver handle |
| 343 | * @param block If call should block if inference is running |
| 344 | * @return -2 on inference not invoked, -1 on inference error, 0 on success, 1 on inference running |
Jonny Svärd | 1a3bb92 | 2022-02-25 16:28:21 +0100 | [diff] [blame] | 345 | */ |
| 346 | int ethosu_wait(struct ethosu_driver *drv, bool block); |
| 347 | |
| 348 | /** |
Kristofer Jonsson | 68b5c91 | 2022-11-14 10:52:38 +0100 | [diff] [blame] | 349 | * Reserves a driver to execute inference with. Call will block until a driver |
| 350 | * is available. |
| 351 | * |
| 352 | * @return Pointer to driver handle. |
Anton Moberg | 61da4d3 | 2020-12-22 16:00:31 +0100 | [diff] [blame] | 353 | */ |
| 354 | struct ethosu_driver *ethosu_reserve_driver(void); |
| 355 | |
| 356 | /** |
Kristofer Jonsson | 68b5c91 | 2022-11-14 10:52:38 +0100 | [diff] [blame] | 357 | * Release driver that was previously reserved with @see ethosu_reserve_driver. |
| 358 | * |
| 359 | * @param drv Pointer to driver handle |
Anton Moberg | 61da4d3 | 2020-12-22 16:00:31 +0100 | [diff] [blame] | 360 | */ |
| 361 | void ethosu_release_driver(struct ethosu_driver *drv); |
Anton Moberg | 8d65b6f | 2020-12-21 09:37:18 +0100 | [diff] [blame] | 362 | |
Anton Moberg | df386e0 | 2021-02-02 11:26:48 +0100 | [diff] [blame] | 363 | /** |
Kristofer Jonsson | 68b5c91 | 2022-11-14 10:52:38 +0100 | [diff] [blame] | 364 | * Static inline for backwards-compatibility. |
| 365 | * |
| 366 | * @see ethosu_invoke_v3 for documentation. |
Kristofer Jonsson | be0bc46 | 2021-06-28 11:44:42 +0000 | [diff] [blame] | 367 | */ |
| 368 | static inline int ethosu_invoke_v2(const void *custom_data_ptr, |
| 369 | const int custom_data_size, |
Ledion Daja | ecdce6c | 2023-01-16 15:39:29 +0100 | [diff] [blame] | 370 | uint64_t *const base_addr, |
Kristofer Jonsson | be0bc46 | 2021-06-28 11:44:42 +0000 | [diff] [blame] | 371 | const size_t *base_addr_size, |
| 372 | const int num_base_addr) |
| 373 | { |
| 374 | struct ethosu_driver *drv = ethosu_reserve_driver(); |
Ledion Daja | ecdce6c | 2023-01-16 15:39:29 +0100 | [diff] [blame] | 375 | if (!drv) |
| 376 | { |
| 377 | return -1; |
| 378 | } |
Kristofer Jonsson | b3cde3c | 2022-01-27 17:30:15 +0100 | [diff] [blame] | 379 | int result = ethosu_invoke_v3(drv, custom_data_ptr, custom_data_size, base_addr, base_addr_size, num_base_addr, 0); |
Kristofer Jonsson | be0bc46 | 2021-06-28 11:44:42 +0000 | [diff] [blame] | 380 | ethosu_release_driver(drv); |
| 381 | return result; |
| 382 | } |
| 383 | |
Kristofer Jonsson | 49bdee8 | 2020-04-06 13:21:21 +0200 | [diff] [blame] | 384 | #ifdef __cplusplus |
| 385 | } |
| 386 | #endif |
Kristofer Jonsson | 3c43917 | 2020-08-05 09:38:40 +0200 | [diff] [blame] | 387 | |
| 388 | #endif // ETHOSU_DRIVER_H |