Kristofer Jonsson | 49bdee8 | 2020-04-06 13:21:21 +0200 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (c) 2019-2020 Arm Limited. All rights reserved. |
| 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; |
Bhavik Patel | dae5be0 | 2020-06-18 15:25:15 +0200 | [diff] [blame] | 50 | }; |
| 51 | |
Kristofer Jonsson | 49bdee8 | 2020-04-06 13:21:21 +0200 | [diff] [blame] | 52 | struct ethosu_version_id |
| 53 | { |
| 54 | // Ethos-U id |
| 55 | uint8_t version_status; |
| 56 | uint8_t version_minor; |
| 57 | uint8_t version_major; |
| 58 | uint8_t product_major; |
| 59 | uint8_t arch_patch_rev; |
| 60 | uint8_t arch_minor_rev; |
| 61 | uint8_t arch_major_rev; |
| 62 | |
| 63 | // Driver Version |
| 64 | uint8_t driver_patch_rev; |
| 65 | uint8_t driver_minor_rev; |
| 66 | uint8_t driver_major_rev; |
| 67 | }; |
| 68 | |
| 69 | struct ethosu_version_config |
| 70 | { |
| 71 | uint8_t macs_per_cc; |
| 72 | uint8_t cmd_stream_version; |
| 73 | uint8_t shram_size; |
| 74 | }; |
| 75 | |
| 76 | struct ethosu_version |
| 77 | { |
| 78 | struct ethosu_version_id id; |
| 79 | struct ethosu_version_config cfg; |
| 80 | }; |
| 81 | |
| 82 | /****************************************************************************** |
Kristofer Jonsson | 4dc73dc | 2020-10-16 12:33:47 +0200 | [diff] [blame] | 83 | * Variables |
| 84 | ******************************************************************************/ |
| 85 | |
| 86 | extern struct ethosu_driver ethosu_drv; |
| 87 | |
| 88 | /****************************************************************************** |
Kristofer Jonsson | 49bdee8 | 2020-04-06 13:21:21 +0200 | [diff] [blame] | 89 | * Prototypes |
| 90 | ******************************************************************************/ |
| 91 | |
| 92 | /** |
| 93 | * Initialize the Ethos-U driver. |
| 94 | */ |
Anton Moberg | 61da4d3 | 2020-12-22 16:00:31 +0100 | [diff] [blame] | 95 | int ethosu_init_v4(struct ethosu_driver *drv, |
| 96 | const void *base_address, |
Per Åstrand | e6498f0 | 2020-11-09 15:33:12 +0100 | [diff] [blame] | 97 | const void *fast_memory, |
| 98 | const size_t fast_memory_size, |
| 99 | uint32_t secure_enable, |
| 100 | uint32_t privilege_enable); |
Kristofer Jonsson | 2b201c3 | 2020-09-02 16:42:43 +0200 | [diff] [blame] | 101 | |
Per Åstrand | 849cf69 | 2020-11-24 07:39:55 +0100 | [diff] [blame] | 102 | #define ethosu_init(base_address) ethosu_init_v3(base_address, NULL, 0, 0, 0) |
Per Åstrand | e6498f0 | 2020-11-09 15:33:12 +0100 | [diff] [blame] | 103 | #define ethosu_init_v2(base_address, fast_memory, fast_memory_size) \ |
Per Åstrand | 849cf69 | 2020-11-24 07:39:55 +0100 | [diff] [blame] | 104 | ethosu_init_v3(base_address, fast_memory, fast_memory_size, 0, 0) |
Anton Moberg | 61da4d3 | 2020-12-22 16:00:31 +0100 | [diff] [blame] | 105 | #define ethosu_init_v3(base_address, fast_memory, fast_memory_size, secure_enable, privilege_enable) \ |
| 106 | ethosu_init_v4(ðosu_drv, base_address, fast_memory, fast_memory_size, secure_enable, privilege_enable) |
Kristofer Jonsson | 49bdee8 | 2020-04-06 13:21:21 +0200 | [diff] [blame] | 107 | |
| 108 | /** |
| 109 | * Get Ethos-U version. |
| 110 | */ |
Anton Moberg | 61da4d3 | 2020-12-22 16:00:31 +0100 | [diff] [blame] | 111 | int ethosu_get_version_v2(struct ethosu_driver *drv, struct ethosu_version *version); |
| 112 | |
| 113 | #define ethosu_get_version(version) ethosu_get_version_v2(ðosu_drv, version) |
Kristofer Jonsson | 49bdee8 | 2020-04-06 13:21:21 +0200 | [diff] [blame] | 114 | |
| 115 | /** |
| 116 | * Invoke Vela command stream. |
| 117 | */ |
Anton Moberg | 61da4d3 | 2020-12-22 16:00:31 +0100 | [diff] [blame] | 118 | int ethosu_invoke_v3(struct ethosu_driver *drv, |
| 119 | const void *custom_data_ptr, |
Kristofer Jonsson | 2b201c3 | 2020-09-02 16:42:43 +0200 | [diff] [blame] | 120 | const int custom_data_size, |
| 121 | const uint64_t *base_addr, |
| 122 | const size_t *base_addr_size, |
| 123 | const int num_base_addr); |
| 124 | |
| 125 | #define ethosu_invoke(custom_data_ptr, custom_data_size, base_addr, num_base_addr) \ |
| 126 | ethosu_invoke_v2(custom_data_ptr, custom_data_size, base_addr, NULL, num_base_addr) |
Anton Moberg | 61da4d3 | 2020-12-22 16:00:31 +0100 | [diff] [blame] | 127 | #define ethosu_invoke_v2(custom_data_ptr, custom_data_size, base_addr, base_addr_size, num_base_addr) \ |
| 128 | ethosu_invoke_v3(ðosu_drv, custom_data_ptr, custom_data_size, base_addr, base_addr_size, num_base_addr) |
Kristofer Jonsson | 2b201c3 | 2020-09-02 16:42:43 +0200 | [diff] [blame] | 129 | |
Kristofer Jonsson | 49bdee8 | 2020-04-06 13:21:21 +0200 | [diff] [blame] | 130 | /** |
| 131 | * Abort Ethos-U inference. |
| 132 | */ |
Anton Moberg | 61da4d3 | 2020-12-22 16:00:31 +0100 | [diff] [blame] | 133 | void ethosu_abort_v2(struct ethosu_driver *drv); |
| 134 | |
| 135 | #define ethosu_abort(void) ethosu_abort_v2(ðosu_drv) |
Kristofer Jonsson | 49bdee8 | 2020-04-06 13:21:21 +0200 | [diff] [blame] | 136 | |
Per Åstrand | 25d78c0 | 2020-04-21 14:19:44 +0200 | [diff] [blame] | 137 | /** |
| 138 | * Interrupt handler do be called on IRQ from Ethos-U |
| 139 | */ |
Anton Moberg | 61da4d3 | 2020-12-22 16:00:31 +0100 | [diff] [blame] | 140 | void ethosu_irq_handler_v2(struct ethosu_driver *drv); |
| 141 | |
| 142 | #define ethosu_irq_handler(void) ethosu_irq_handler_v2(ðosu_drv) |
Per Åstrand | 25d78c0 | 2020-04-21 14:19:44 +0200 | [diff] [blame] | 143 | |
Anton Moberg | 8d65b6f | 2020-12-21 09:37:18 +0100 | [diff] [blame] | 144 | /** |
| 145 | * Set Ethos-U power mode. |
| 146 | */ |
Anton Moberg | 61da4d3 | 2020-12-22 16:00:31 +0100 | [diff] [blame] | 147 | void ethosu_set_power_mode_v2(struct ethosu_driver *drv, bool always_on); |
| 148 | |
| 149 | #define ethosu_set_power_mode(always_on) ethosu_set_power_mode_v2(ðosu_drv, always_on) |
| 150 | |
| 151 | /** |
| 152 | * Register a driver for multiNPU usage |
| 153 | */ |
| 154 | int ethosu_register_driver(struct ethosu_driver *drv); |
| 155 | |
| 156 | /** |
| 157 | * Deregister a driver from multiNPU usage |
| 158 | */ |
| 159 | int ethosu_deregister_driver(struct ethosu_driver *drv); |
| 160 | |
| 161 | /** |
| 162 | * Find, reserve, and return the first available driver |
| 163 | */ |
| 164 | struct ethosu_driver *ethosu_reserve_driver(void); |
| 165 | |
| 166 | /** |
| 167 | * Change driver status to available |
| 168 | */ |
| 169 | void ethosu_release_driver(struct ethosu_driver *drv); |
Anton Moberg | 8d65b6f | 2020-12-21 09:37:18 +0100 | [diff] [blame] | 170 | |
Kristofer Jonsson | 49bdee8 | 2020-04-06 13:21:21 +0200 | [diff] [blame] | 171 | #ifdef __cplusplus |
| 172 | } |
| 173 | #endif |
Kristofer Jonsson | 3c43917 | 2020-08-05 09:38:40 +0200 | [diff] [blame] | 174 | |
| 175 | #endif // ETHOSU_DRIVER_H |