Kristofer Jonsson | 116a635 | 2020-08-20 17:25:23 +0200 | [diff] [blame] | 1 | /* |
Kristofer Jonsson | b42bc0b | 2023-01-04 17:09:28 +0100 | [diff] [blame] | 2 | * Copyright 2020-2023 Arm Limited and/or its affiliates |
Kristofer Jonsson | 116a635 | 2020-08-20 17:25:23 +0200 | [diff] [blame] | 3 | * |
| 4 | * This program is free software and is provided to you under the terms of the |
| 5 | * GNU General Public License version 2 as published by the Free Software |
| 6 | * Foundation, and any use by you of this program is subject to the terms |
| 7 | * of such GNU licence. |
| 8 | * |
| 9 | * This program is distributed in the hope that it will be useful, |
| 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 12 | * GNU General Public License for more details. |
| 13 | * |
| 14 | * You should have received a copy of the GNU General Public License |
| 15 | * along with this program; if not, you can access it online at |
| 16 | * http://www.gnu.org/licenses/gpl-2.0.html. |
| 17 | * |
| 18 | * SPDX-License-Identifier: GPL-2.0-only |
| 19 | */ |
| 20 | |
| 21 | #ifndef ETHOSU_MAILBOX_H |
| 22 | #define ETHOSU_MAILBOX_H |
| 23 | |
| 24 | /**************************************************************************** |
| 25 | * Includes |
| 26 | ****************************************************************************/ |
Kristofer Jonsson | d779a08 | 2023-01-04 17:09:47 +0100 | [diff] [blame] | 27 | #include "ethosu_core_rpmsg.h" |
Kristofer Jonsson | 116a635 | 2020-08-20 17:25:23 +0200 | [diff] [blame] | 28 | |
| 29 | #include <linux/types.h> |
| 30 | #include <linux/mailbox_client.h> |
| 31 | #include <linux/workqueue.h> |
Davide Grohmann | 32660f9 | 2022-04-27 16:49:07 +0200 | [diff] [blame] | 32 | #include <linux/idr.h> |
Kristofer Jonsson | 116a635 | 2020-08-20 17:25:23 +0200 | [diff] [blame] | 33 | |
| 34 | /**************************************************************************** |
| 35 | * Types |
| 36 | ****************************************************************************/ |
| 37 | |
| 38 | struct device; |
| 39 | struct ethosu_buffer; |
| 40 | struct ethosu_device; |
| 41 | struct ethosu_core_msg; |
| 42 | struct ethosu_core_queue; |
| 43 | struct resource; |
| 44 | |
| 45 | typedef void (*ethosu_mailbox_cb)(void *user_arg); |
| 46 | |
| 47 | struct ethosu_mailbox { |
Kristofer Jonsson | d779a08 | 2023-01-04 17:09:47 +0100 | [diff] [blame] | 48 | struct device *dev; |
| 49 | struct rpmsg_endpoint *ept; |
| 50 | struct idr msg_idr; |
Kristofer Jonsson | 442fefb | 2022-03-17 17:15:52 +0100 | [diff] [blame] | 51 | }; |
| 52 | |
| 53 | struct ethosu_mailbox_msg { |
Davide Grohmann | 32660f9 | 2022-04-27 16:49:07 +0200 | [diff] [blame] | 54 | int id; |
| 55 | void (*fail)(struct ethosu_mailbox_msg *msg); |
Kristofer Jonsson | 116a635 | 2020-08-20 17:25:23 +0200 | [diff] [blame] | 56 | }; |
| 57 | |
| 58 | /**************************************************************************** |
| 59 | * Functions |
| 60 | ****************************************************************************/ |
| 61 | |
| 62 | /** |
| 63 | * ethosu_mailbox_init() - Initialize mailbox |
| 64 | * |
| 65 | * Return: 0 on success, else error code. |
| 66 | */ |
| 67 | int ethosu_mailbox_init(struct ethosu_mailbox *mbox, |
| 68 | struct device *dev, |
Kristofer Jonsson | d779a08 | 2023-01-04 17:09:47 +0100 | [diff] [blame] | 69 | struct rpmsg_endpoint *ept); |
Kristofer Jonsson | 116a635 | 2020-08-20 17:25:23 +0200 | [diff] [blame] | 70 | |
| 71 | /** |
| 72 | * ethosu_mailbox_deinit() - Deinitialize mailbox |
| 73 | */ |
| 74 | void ethosu_mailbox_deinit(struct ethosu_mailbox *mbox); |
| 75 | |
| 76 | /** |
Davide Grohmann | 32660f9 | 2022-04-27 16:49:07 +0200 | [diff] [blame] | 77 | * ethosu_mailbox_register() - Register the ethosu_mailbox_msg in ethosu_mailbox |
Kristofer Jonsson | 442fefb | 2022-03-17 17:15:52 +0100 | [diff] [blame] | 78 | * |
| 79 | * Return: 0 on success, else error code. |
| 80 | */ |
Davide Grohmann | 32660f9 | 2022-04-27 16:49:07 +0200 | [diff] [blame] | 81 | int ethosu_mailbox_register(struct ethosu_mailbox *mbox, |
| 82 | struct ethosu_mailbox_msg *msg); |
| 83 | |
| 84 | /** |
| 85 | * ethosu_mailbox_free_id() - Free the id of the ethosu_mailbox_msg |
| 86 | */ |
| 87 | void ethosu_mailbox_deregister(struct ethosu_mailbox *mbox, |
| 88 | struct ethosu_mailbox_msg *msg); |
| 89 | |
| 90 | /** |
| 91 | * ethosu_mailbox_find() - Find mailbox message |
| 92 | * |
| 93 | * Return: a valid pointer on success, otherwise an error ptr. |
| 94 | */ |
| 95 | struct ethosu_mailbox_msg *ethosu_mailbox_find(struct ethosu_mailbox *mbox, |
| 96 | int msg_id); |
Kristofer Jonsson | 442fefb | 2022-03-17 17:15:52 +0100 | [diff] [blame] | 97 | |
| 98 | /** |
| 99 | * ethosu_mailbox_fail() - Fail mailbox messages |
| 100 | * |
| 101 | * Call fail() callback on all messages in pending list. |
| 102 | */ |
| 103 | void ethosu_mailbox_fail(struct ethosu_mailbox *mbox); |
| 104 | |
| 105 | /** |
Jonny Svärd | 7c24c77 | 2021-01-14 19:53:17 +0100 | [diff] [blame] | 106 | * ethosu_mailbox_reset() - Reset to end of queue |
| 107 | */ |
| 108 | void ethosu_mailbox_reset(struct ethosu_mailbox *mbox); |
| 109 | |
| 110 | /** |
Kristofer Jonsson | 116a635 | 2020-08-20 17:25:23 +0200 | [diff] [blame] | 111 | * ethosu_mailbox_ping() - Send ping message |
| 112 | * |
| 113 | * Return: 0 on success, else error code. |
| 114 | */ |
| 115 | int ethosu_mailbox_ping(struct ethosu_mailbox *mbox); |
| 116 | |
| 117 | /** |
Jonny Svärd | 7c24c77 | 2021-01-14 19:53:17 +0100 | [diff] [blame] | 118 | * ethosu_mailbox_pong() - Send pong response |
| 119 | * |
| 120 | * Return: 0 on success, else error code. |
| 121 | */ |
| 122 | int ethosu_mailbox_pong(struct ethosu_mailbox *mbox); |
| 123 | |
| 124 | /** |
| 125 | * ethosu_mailbox_version_response - Send version request |
| 126 | * |
| 127 | * Return: 0 on succes, else error code |
| 128 | */ |
| 129 | int ethosu_mailbox_version_request(struct ethosu_mailbox *mbox); |
| 130 | |
| 131 | /** |
Davide Grohmann | 35ce6c8 | 2021-06-01 15:03:51 +0200 | [diff] [blame] | 132 | * ethosu_mailbox_capabilities_request() - Send capabilities request |
| 133 | * |
| 134 | * Return: 0 on success, else error code. |
| 135 | */ |
| 136 | int ethosu_mailbox_capabilities_request(struct ethosu_mailbox *mbox, |
Davide Grohmann | 32660f9 | 2022-04-27 16:49:07 +0200 | [diff] [blame] | 137 | struct ethosu_mailbox_msg *msg); |
Davide Grohmann | 35ce6c8 | 2021-06-01 15:03:51 +0200 | [diff] [blame] | 138 | |
| 139 | /** |
Kristofer Jonsson | 116a635 | 2020-08-20 17:25:23 +0200 | [diff] [blame] | 140 | * ethosu_mailbox_inference() - Send inference |
| 141 | * |
| 142 | * Return: 0 on success, else error code. |
| 143 | */ |
| 144 | int ethosu_mailbox_inference(struct ethosu_mailbox *mbox, |
Davide Grohmann | 32660f9 | 2022-04-27 16:49:07 +0200 | [diff] [blame] | 145 | struct ethosu_mailbox_msg *msg, |
Kristofer Jonsson | b74492c | 2020-09-10 13:26:01 +0200 | [diff] [blame] | 146 | uint32_t ifm_count, |
| 147 | struct ethosu_buffer **ifm, |
| 148 | uint32_t ofm_count, |
| 149 | struct ethosu_buffer **ofm, |
Per Åstrand | f7e407a | 2020-10-23 21:25:05 +0200 | [diff] [blame] | 150 | struct ethosu_buffer *network, |
Kristofer Jonsson | 35de9e6 | 2022-03-08 13:25:45 +0100 | [diff] [blame] | 151 | uint32_t network_index, |
Per Åstrand | f7e407a | 2020-10-23 21:25:05 +0200 | [diff] [blame] | 152 | uint8_t *pmu_event_config, |
| 153 | uint8_t pmu_event_config_count, |
| 154 | uint8_t pmu_cycle_counter_enable); |
Kristofer Jonsson | 116a635 | 2020-08-20 17:25:23 +0200 | [diff] [blame] | 155 | |
Kristofer Jonsson | 3c6a260 | 2022-03-10 11:17:29 +0100 | [diff] [blame] | 156 | /** |
| 157 | * ethosu_mailbox_network_info_request() - Send network info request |
| 158 | * |
| 159 | * Return: 0 on success, else error code. |
| 160 | */ |
| 161 | int ethosu_mailbox_network_info_request(struct ethosu_mailbox *mbox, |
Davide Grohmann | 32660f9 | 2022-04-27 16:49:07 +0200 | [diff] [blame] | 162 | struct ethosu_mailbox_msg *msg, |
Kristofer Jonsson | 3c6a260 | 2022-03-10 11:17:29 +0100 | [diff] [blame] | 163 | struct ethosu_buffer *network, |
| 164 | uint32_t network_index); |
| 165 | |
Davide Grohmann | 7e8f508 | 2022-03-23 12:48:45 +0100 | [diff] [blame] | 166 | /** |
| 167 | * ethosu_mailbox_cancel_inference() - Send inference cancellation |
| 168 | * |
| 169 | * Return: 0 on success, else error code. |
| 170 | */ |
| 171 | int ethosu_mailbox_cancel_inference(struct ethosu_mailbox *mbox, |
Davide Grohmann | 32660f9 | 2022-04-27 16:49:07 +0200 | [diff] [blame] | 172 | struct ethosu_mailbox_msg *msg, |
| 173 | int inference_handle); |
Davide Grohmann | 7e8f508 | 2022-03-23 12:48:45 +0100 | [diff] [blame] | 174 | |
Kristofer Jonsson | 116a635 | 2020-08-20 17:25:23 +0200 | [diff] [blame] | 175 | #endif /* ETHOSU_MAILBOX_H */ |