Kristofer Jonsson | 49bdee8 | 2020-04-06 13:21:21 +0200 | [diff] [blame] | 1 | /* |
Anton Moberg | dfed5fd | 2021-03-11 14:41:11 +0100 | [diff] [blame] | 2 | * Copyright (c) 2019-2021 Arm Limited. All rights reserved. |
Kristofer Jonsson | 49bdee8 | 2020-04-06 13:21:21 +0200 | [diff] [blame] | 3 | * |
| 4 | * SPDX-License-Identifier: Apache-2.0 |
| 5 | * |
| 6 | * Licensed under the Apache License, Version 2.0 (the License); you may |
| 7 | * not use this file except in compliance with the License. |
| 8 | * You may obtain a copy of the License at |
| 9 | * |
| 10 | * www.apache.org/licenses/LICENSE-2.0 |
| 11 | * |
| 12 | * Unless required by applicable law or agreed to in writing, software |
| 13 | * distributed under the License is distributed on an AS IS BASIS, WITHOUT |
| 14 | * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 15 | * See the License for the specific language governing permissions and |
| 16 | * limitations under the License. |
| 17 | */ |
| 18 | |
Kristofer Jonsson | 3c43917 | 2020-08-05 09:38:40 +0200 | [diff] [blame] | 19 | #ifndef ETHOSU_DRIVER_H |
| 20 | #define ETHOSU_DRIVER_H |
Kristofer Jonsson | 49bdee8 | 2020-04-06 13:21:21 +0200 | [diff] [blame] | 21 | |
| 22 | /****************************************************************************** |
| 23 | * Includes |
| 24 | ******************************************************************************/ |
| 25 | |
Bhavik Patel | dae5be0 | 2020-06-18 15:25:15 +0200 | [diff] [blame] | 26 | #include "ethosu_device.h" |
| 27 | |
| 28 | #include <stdbool.h> |
Kristofer Jonsson | 2b201c3 | 2020-09-02 16:42:43 +0200 | [diff] [blame] | 29 | #include <stddef.h> |
Kristofer Jonsson | 49bdee8 | 2020-04-06 13:21:21 +0200 | [diff] [blame] | 30 | #include <stdint.h> |
| 31 | |
| 32 | #ifdef __cplusplus |
| 33 | extern "C" { |
| 34 | #endif |
| 35 | |
| 36 | /****************************************************************************** |
Kristofer Jonsson | 49bdee8 | 2020-04-06 13:21:21 +0200 | [diff] [blame] | 37 | * Types |
| 38 | ******************************************************************************/ |
| 39 | |
Bhavik Patel | dae5be0 | 2020-06-18 15:25:15 +0200 | [diff] [blame] | 40 | struct ethosu_driver |
| 41 | { |
| 42 | struct ethosu_device dev; |
| 43 | bool abort_inference; |
Kristofer Jonsson | 2b201c3 | 2020-09-02 16:42:43 +0200 | [diff] [blame] | 44 | uint64_t fast_memory; |
| 45 | size_t fast_memory_size; |
Bhavik Patel | 5f8dad1 | 2020-09-30 09:06:52 +0200 | [diff] [blame] | 46 | bool status_error; |
Anton Moberg | 8d65b6f | 2020-12-21 09:37:18 +0100 | [diff] [blame] | 47 | bool dev_power_always_on; |
Anton Moberg | 61da4d3 | 2020-12-22 16:00:31 +0100 | [diff] [blame] | 48 | struct ethosu_driver *next; |
| 49 | bool reserved; |
Anton Moberg | dfed5fd | 2021-03-11 14:41:11 +0100 | [diff] [blame] | 50 | volatile bool irq_triggered; |
| 51 | void *semaphore; |
Anton Moberg | 0a61429 | 2021-03-24 14:08:22 +0100 | [diff] [blame] | 52 | uint8_t clock_request; |
| 53 | uint8_t power_request; |
Bhavik Patel | dae5be0 | 2020-06-18 15:25:15 +0200 | [diff] [blame] | 54 | }; |
| 55 | |
Kristofer Jonsson | 49bdee8 | 2020-04-06 13:21:21 +0200 | [diff] [blame] | 56 | struct ethosu_version_id |
| 57 | { |
| 58 | // Ethos-U id |
| 59 | uint8_t version_status; |
| 60 | uint8_t version_minor; |
| 61 | uint8_t version_major; |
| 62 | uint8_t product_major; |
| 63 | uint8_t arch_patch_rev; |
| 64 | uint8_t arch_minor_rev; |
| 65 | uint8_t arch_major_rev; |
| 66 | |
| 67 | // Driver Version |
| 68 | uint8_t driver_patch_rev; |
| 69 | uint8_t driver_minor_rev; |
| 70 | uint8_t driver_major_rev; |
| 71 | }; |
| 72 | |
| 73 | struct ethosu_version_config |
| 74 | { |
| 75 | uint8_t macs_per_cc; |
| 76 | uint8_t cmd_stream_version; |
| 77 | uint8_t shram_size; |
Anton Moberg | b8bcf13 | 2021-03-29 10:02:25 +0200 | [diff] [blame] | 78 | uint8_t custom_dma; |
Kristofer Jonsson | 49bdee8 | 2020-04-06 13:21:21 +0200 | [diff] [blame] | 79 | }; |
| 80 | |
| 81 | struct ethosu_version |
| 82 | { |
| 83 | struct ethosu_version_id id; |
| 84 | struct ethosu_version_config cfg; |
| 85 | }; |
| 86 | |
Anton Moberg | 0a61429 | 2021-03-24 14:08:22 +0100 | [diff] [blame] | 87 | enum ethosu_request_clients |
| 88 | { |
| 89 | ETHOSU_PMU_REQUEST = 0, |
| 90 | ETHOSU_INFERENCE_REQUEST = 1, |
| 91 | }; |
| 92 | |
Kristofer Jonsson | 49bdee8 | 2020-04-06 13:21:21 +0200 | [diff] [blame] | 93 | /****************************************************************************** |
Kristofer Jonsson | 4dc73dc | 2020-10-16 12:33:47 +0200 | [diff] [blame] | 94 | * Variables |
| 95 | ******************************************************************************/ |
| 96 | |
| 97 | extern struct ethosu_driver ethosu_drv; |
| 98 | |
| 99 | /****************************************************************************** |
Kristofer Jonsson | 49bdee8 | 2020-04-06 13:21:21 +0200 | [diff] [blame] | 100 | * Prototypes |
| 101 | ******************************************************************************/ |
| 102 | |
| 103 | /** |
| 104 | * Initialize the Ethos-U driver. |
| 105 | */ |
Anton Moberg | effc7aa | 2021-05-03 09:25:06 +0200 | [diff] [blame] | 106 | int ethosu_init(struct ethosu_driver *drv, |
| 107 | const void *base_address, |
| 108 | const void *fast_memory, |
| 109 | const size_t fast_memory_size, |
| 110 | uint32_t secure_enable, |
| 111 | uint32_t privilege_enable); |
Kristofer Jonsson | 49bdee8 | 2020-04-06 13:21:21 +0200 | [diff] [blame] | 112 | |
| 113 | /** |
| 114 | * Get Ethos-U version. |
| 115 | */ |
Anton Moberg | effc7aa | 2021-05-03 09:25:06 +0200 | [diff] [blame] | 116 | int ethosu_get_version(struct ethosu_driver *drv, struct ethosu_version *version); |
Kristofer Jonsson | 49bdee8 | 2020-04-06 13:21:21 +0200 | [diff] [blame] | 117 | |
| 118 | /** |
| 119 | * Invoke Vela command stream. |
| 120 | */ |
Anton Moberg | effc7aa | 2021-05-03 09:25:06 +0200 | [diff] [blame] | 121 | int ethosu_invoke(struct ethosu_driver *drv, |
| 122 | const void *custom_data_ptr, |
| 123 | const int custom_data_size, |
| 124 | const uint64_t *base_addr, |
| 125 | const size_t *base_addr_size, |
| 126 | const int num_base_addr); |
Kristofer Jonsson | 2b201c3 | 2020-09-02 16:42:43 +0200 | [diff] [blame] | 127 | |
Kristofer Jonsson | 49bdee8 | 2020-04-06 13:21:21 +0200 | [diff] [blame] | 128 | /** |
| 129 | * Abort Ethos-U inference. |
| 130 | */ |
Anton Moberg | effc7aa | 2021-05-03 09:25:06 +0200 | [diff] [blame] | 131 | void ethosu_abort(struct ethosu_driver *drv); |
Kristofer Jonsson | 49bdee8 | 2020-04-06 13:21:21 +0200 | [diff] [blame] | 132 | |
Per Åstrand | 25d78c0 | 2020-04-21 14:19:44 +0200 | [diff] [blame] | 133 | /** |
| 134 | * Interrupt handler do be called on IRQ from Ethos-U |
| 135 | */ |
Anton Moberg | effc7aa | 2021-05-03 09:25:06 +0200 | [diff] [blame] | 136 | void ethosu_irq_handler(struct ethosu_driver *drv); |
Per Åstrand | 25d78c0 | 2020-04-21 14:19:44 +0200 | [diff] [blame] | 137 | |
Anton Moberg | 8d65b6f | 2020-12-21 09:37:18 +0100 | [diff] [blame] | 138 | /** |
| 139 | * Set Ethos-U power mode. |
| 140 | */ |
Anton Moberg | effc7aa | 2021-05-03 09:25:06 +0200 | [diff] [blame] | 141 | void ethosu_set_power_mode(struct ethosu_driver *drv, bool always_on); |
Anton Moberg | 61da4d3 | 2020-12-22 16:00:31 +0100 | [diff] [blame] | 142 | |
| 143 | /** |
| 144 | * Register a driver for multiNPU usage |
| 145 | */ |
| 146 | int ethosu_register_driver(struct ethosu_driver *drv); |
| 147 | |
| 148 | /** |
| 149 | * Deregister a driver from multiNPU usage |
| 150 | */ |
| 151 | int ethosu_deregister_driver(struct ethosu_driver *drv); |
| 152 | |
| 153 | /** |
Anton Moberg | df386e0 | 2021-02-02 11:26:48 +0100 | [diff] [blame] | 154 | * Reserves a driver to execute inference with |
Anton Moberg | 61da4d3 | 2020-12-22 16:00:31 +0100 | [diff] [blame] | 155 | */ |
| 156 | struct ethosu_driver *ethosu_reserve_driver(void); |
| 157 | |
| 158 | /** |
| 159 | * Change driver status to available |
| 160 | */ |
| 161 | void ethosu_release_driver(struct ethosu_driver *drv); |
Anton Moberg | 8d65b6f | 2020-12-21 09:37:18 +0100 | [diff] [blame] | 162 | |
Anton Moberg | df386e0 | 2021-02-02 11:26:48 +0100 | [diff] [blame] | 163 | /** |
Anton Moberg | 0a61429 | 2021-03-24 14:08:22 +0100 | [diff] [blame] | 164 | * Set clock and power request bits |
| 165 | */ |
| 166 | enum ethosu_error_codes set_clock_and_power_request(struct ethosu_driver *drv, |
| 167 | enum ethosu_request_clients client, |
| 168 | enum ethosu_clock_q_request clock_request, |
| 169 | enum ethosu_power_q_request power_request); |
| 170 | |
| 171 | /** |
Anton Moberg | df386e0 | 2021-02-02 11:26:48 +0100 | [diff] [blame] | 172 | * Static inline for backwards-compatibility |
| 173 | */ |
| 174 | static inline int ethosu_invoke_v2(const void *custom_data_ptr, |
| 175 | const int custom_data_size, |
| 176 | const uint64_t *base_addr, |
| 177 | const size_t *base_addr_size, |
| 178 | const int num_base_addr) |
| 179 | { |
| 180 | struct ethosu_driver *drv = ethosu_reserve_driver(); |
Anton Moberg | effc7aa | 2021-05-03 09:25:06 +0200 | [diff] [blame] | 181 | int result = ethosu_invoke(drv, custom_data_ptr, custom_data_size, base_addr, base_addr_size, num_base_addr); |
Anton Moberg | df386e0 | 2021-02-02 11:26:48 +0100 | [diff] [blame] | 182 | ethosu_release_driver(drv); |
| 183 | return result; |
| 184 | } |
| 185 | |
Kristofer Jonsson | 49bdee8 | 2020-04-06 13:21:21 +0200 | [diff] [blame] | 186 | #ifdef __cplusplus |
| 187 | } |
| 188 | #endif |
Kristofer Jonsson | 3c43917 | 2020-08-05 09:38:40 +0200 | [diff] [blame] | 189 | |
| 190 | #endif // ETHOSU_DRIVER_H |