remoteproc: resource table: add fw checksum rsc
[processor-sdk/open-amp.git] / lib / include / openamp / remoteproc.h
1 /*
2  * Remote remote_proc Framework
3  *
4  * Copyright(c) 2011 Texas Instruments, Inc.
5  * Copyright(c) 2011 Google, Inc.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * * Redistributions of source code must retain the above copyright
13  *   notice, this list of conditions and the following disclaimer.
14  * * Redistributions in binary form must reproduce the above copyright
15  *   notice, this list of conditions and the following disclaimer in
16  *   the documentation and/or other materials provided with the
17  *   distribution.
18  * * Neither the name Texas Instruments nor the names of its
19  *   contributors may be used to endorse or promote products derived
20  *   from this software without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33  */
35 #ifndef REMOTEPROC_H
36 #define REMOTEPROC_H
38 #include "openamp/rpmsg.h"
39 #include "openamp/firmware.h"
40 /**
41  * struct resource_table - firmware resource table header
42  * @ver: version number
43  * @num: number of resource entries
44  * @reserved: reserved (must be zero)
45  * @offset: array of offsets pointing at the various resource entries
46  *
47  * A resource table is essentially a list of system resources required
48  * by the remote remote_proc. It may also include configuration entries.
49  * If needed, the remote remote_proc firmware should contain this table
50  * as a dedicated ".resource_table" ELF section.
51  *
52  * Some resources entries are mere announcements, where the host is informed
53  * of specific remoteproc configuration. Other entries require the host to
54  * do something (e.g. allocate a system resource). Sometimes a negotiation
55  * is expected, where the firmware requests a resource, and once allocated,
56  * the host should provide back its details (e.g. address of an allocated
57  * memory region).
58  *
59  * The header of the resource table, as expressed by this structure,
60  * contains a version number (should we need to change this format in the
61  * future), the number of available resource entries, and their offsets
62  * in the table.
63  *
64  * Immediately following this header are the resource entries themselves,
65  * each of which begins with a resource entry header (as described below).
66  */
67 OPENAMP_PACKED_BEGIN
68 struct resource_table {
69         uint32_t ver;
70         uint32_t num;
71         uint32_t reserved[2];
72         uint32_t offset[0];
73 } OPENAMP_PACKED_END;
75 /**
76  * struct fw_rsc_hdr - firmware resource entry header
77  * @type: resource type
78  * @data: resource data
79  *
80  * Every resource entry begins with a 'struct fw_rsc_hdr' header providing
81  * its @type. The content of the entry itself will immediately follow
82  * this header, and it should be parsed according to the resource type.
83  */
84 OPENAMP_PACKED_BEGIN
85 struct fw_rsc_hdr {
86         uint32_t type;
87         uint8_t data[0];
88 } OPENAMP_PACKED_END;
90 /**
91  * enum fw_resource_type - types of resource entries
92  *
93  * @RSC_CARVEOUT:   request for allocation of a physically contiguous
94  *          memory region.
95  * @RSC_DEVMEM:     request to iommu_map a memory-based peripheral.
96  * @RSC_TRACE:      announces the availability of a trace buffer into which
97  *          the remote remote_proc will be writing logs.
98  * @RSC_VDEV:       declare support for a virtio device, and serve as its
99  *          virtio header.
100  * @RSC_LAST:       just keep this one at the end
101  *
102  * For more details regarding a specific resource type, please see its
103  * dedicated structure below.
104  *
105  * Please note that these values are used as indices to the rproc_handle_rsc
106  * lookup table, so please keep them sane. Moreover, @RSC_LAST is used to
107  * check the validity of an index before the lookup table is accessed, so
108  * please update it as needed.
109  */
110 enum fw_resource_type {
111         RSC_CARVEOUT = 0,
112         RSC_DEVMEM = 1,
113         RSC_TRACE = 2,
114         RSC_VDEV = 3,
115         RSC_RPROC_MEM = 4,
116         RSC_FW_CHKSUM = 5,
117         RSC_LAST = 6,
118 };
120 #define FW_RSC_ADDR_ANY (0xFFFFFFFFFFFFFFFF)
122 /**
123  * struct fw_rsc_carveout - physically contiguous memory request
124  * @da: device address
125  * @pa: physical address
126  * @len: length (in bytes)
127  * @flags: iommu protection flags
128  * @reserved: reserved (must be zero)
129  * @name: human-readable name of the requested memory region
130  *
131  * This resource entry requests the host to allocate a physically contiguous
132  * memory region.
133  *
134  * These request entries should precede other firmware resource entries,
135  * as other entries might request placing other data objects inside
136  * these memory regions (e.g. data/code segments, trace resource entries, ...).
137  *
138  * Allocating memory this way helps utilizing the reserved physical memory
139  * (e.g. CMA) more efficiently, and also minimizes the number of TLB entries
140  * needed to map it (in case @rproc is using an IOMMU). Reducing the TLB
141  * pressure is important; it may have a substantial impact on performance.
142  *
143  * If the firmware is compiled with static addresses, then @da should specify
144  * the expected device address of this memory region. If @da is set to
145  * FW_RSC_ADDR_ANY, then the host will dynamically allocate it, and then
146  * overwrite @da with the dynamically allocated address.
147  *
148  * We will always use @da to negotiate the device addresses, even if it
149  * isn't using an iommu. In that case, though, it will obviously contain
150  * physical addresses.
151  *
152  * Some remote remote_procs needs to know the allocated physical address
153  * even if they do use an iommu. This is needed, e.g., if they control
154  * hardware accelerators which access the physical memory directly (this
155  * is the case with OMAP4 for instance). In that case, the host will
156  * overwrite @pa with the dynamically allocated physical address.
157  * Generally we don't want to expose physical addresses if we don't have to
158  * (remote remote_procs are generally _not_ trusted), so we might want to
159  * change this to happen _only_ when explicitly required by the hardware.
160  *
161  * @flags is used to provide IOMMU protection flags, and @name should
162  * (optionally) contain a human readable name of this carveout region
163  * (mainly for debugging purposes).
164  */
165 OPENAMP_PACKED_BEGIN
166 struct fw_rsc_carveout {
167         uint32_t type;
168         uint32_t da;
169         uint32_t pa;
170         uint32_t len;
171         uint32_t flags;
172         uint32_t reserved;
173         uint8_t name[32];
174 } OPENAMP_PACKED_END;
176 /**
177  * struct fw_rsc_devmem - iommu mapping request
178  * @da: device address
179  * @pa: physical address
180  * @len: length (in bytes)
181  * @flags: iommu protection flags
182  * @reserved: reserved (must be zero)
183  * @name: human-readable name of the requested region to be mapped
184  *
185  * This resource entry requests the host to iommu map a physically contiguous
186  * memory region. This is needed in case the remote remote_proc requires
187  * access to certain memory-based peripherals; _never_ use it to access
188  * regular memory.
189  *
190  * This is obviously only needed if the remote remote_proc is accessing memory
191  * via an iommu.
192  *
193  * @da should specify the required device address, @pa should specify
194  * the physical address we want to map, @len should specify the size of
195  * the mapping and @flags is the IOMMU protection flags. As always, @name may
196  * (optionally) contain a human readable name of this mapping (mainly for
197  * debugging purposes).
198  *
199  * Note: at this point we just "trust" those devmem entries to contain valid
200  * physical addresses, but this isn't safe and will be changed: eventually we
201  * want remoteproc implementations to provide us ranges of physical addresses
202  * the firmware is allowed to request, and not allow firmwares to request
203  * access to physical addresses that are outside those ranges.
204  */
205 OPENAMP_PACKED_BEGIN
206 struct fw_rsc_devmem {
207         uint32_t type;
208         uint32_t da;
209         uint32_t pa;
210         uint32_t len;
211         uint32_t flags;
212         uint32_t reserved;
213         uint8_t name[32];
214 } OPENAMP_PACKED_END;
216 /**
217  * struct fw_rsc_trace - trace buffer declaration
218  * @da: device address
219  * @len: length (in bytes)
220  * @reserved: reserved (must be zero)
221  * @name: human-readable name of the trace buffer
222  *
223  * This resource entry provides the host information about a trace buffer
224  * into which the remote remote_proc will write log messages.
225  *
226  * @da specifies the device address of the buffer, @len specifies
227  * its size, and @name may contain a human readable name of the trace buffer.
228  *
229  * After booting the remote remote_proc, the trace buffers are exposed to the
230  * user via debugfs entries (called trace0, trace1, etc..).
231  */
232 OPENAMP_PACKED_BEGIN
233 struct fw_rsc_trace {
234         uint32_t type;
235         uint32_t da;
236         uint32_t len;
237         uint32_t reserved;
238         uint8_t name[32];
239 } OPENAMP_PACKED_END;
241 /**
242  * struct fw_rsc_vdev_vring - vring descriptor entry
243  * @da: device address
244  * @align: the alignment between the consumer and producer parts of the vring
245  * @num: num of buffers supported by this vring (must be power of two)
246  * @notifyid is a unique rproc-wide notify index for this vring. This notify
247  * index is used when kicking a remote remote_proc, to let it know that this
248  * vring is triggered.
249  * @reserved: reserved (must be zero)
250  *
251  * This descriptor is not a resource entry by itself; it is part of the
252  * vdev resource type (see below).
253  *
254  * Note that @da should either contain the device address where
255  * the remote remote_proc is expecting the vring, or indicate that
256  * dynamically allocation of the vring's device address is supported.
257  */
258 OPENAMP_PACKED_BEGIN
259 struct fw_rsc_vdev_vring {
260         uint32_t da;
261         uint32_t align;
262         uint32_t num;
263         uint32_t notifyid;
264         uint32_t reserved;
265 } OPENAMP_PACKED_END;
267 /**
268  * struct fw_rsc_vdev - virtio device header
269  * @id: virtio device id (as in virtio_ids.h)
270  * @notifyid is a unique rproc-wide notify index for this vdev. This notify
271  * index is used when kicking a remote remote_proc, to let it know that the
272  * status/features of this vdev have changes.
273  * @dfeatures specifies the virtio device features supported by the firmware
274  * @gfeatures is a place holder used by the host to write back the
275  * negotiated features that are supported by both sides.
276  * @config_len is the size of the virtio config space of this vdev. The config
277  * space lies in the resource table immediate after this vdev header.
278  * @status is a place holder where the host will indicate its virtio progress.
279  * @num_of_vrings indicates how many vrings are described in this vdev header
280  * @reserved: reserved (must be zero)
281  * @vring is an array of @num_of_vrings entries of 'struct fw_rsc_vdev_vring'.
282  *
283  * This resource is a virtio device header: it provides information about
284  * the vdev, and is then used by the host and its peer remote remote_procs
285  * to negotiate and share certain virtio properties.
286  *
287  * By providing this resource entry, the firmware essentially asks remoteproc
288  * to statically allocate a vdev upon registration of the rproc (dynamic vdev
289  * allocation is not yet supported).
290  *
291  * Note: unlike virtualization systems, the term 'host' here means
292  * the Linux side which is running remoteproc to control the remote
293  * remote_procs. We use the name 'gfeatures' to comply with virtio's terms,
294  * though there isn't really any virtualized guest OS here: it's the host
295  * which is responsible for negotiating the final features.
296  * Yeah, it's a bit confusing.
297  *
298  * Note: immediately following this structure is the virtio config space for
299  * this vdev (which is specific to the vdev; for more info, read the virtio
300  * spec). the size of the config space is specified by @config_len.
301  */
302 OPENAMP_PACKED_BEGIN
303 struct fw_rsc_vdev {
304         uint32_t type;
305         uint32_t id;
306         uint32_t notifyid;
307         uint32_t dfeatures;
308         uint32_t gfeatures;
309         uint32_t config_len;
310         uint8_t status;
311         uint8_t num_of_vrings;
312         uint8_t reserved[2];
313         struct fw_rsc_vdev_vring vring[0];
314 } OPENAMP_PACKED_END;
316 /**
317  * struct fw_rsc_rproc_mem - remote processor memory
318  * @da: device address
319  * @pa: physical address
320  * @len: length (in bytes)
321  * @reserved: reserved (must be zero)
322  *
323  * This resource entry tells the host to the remote processor
324  * memory that the host can be used as shared memory.
325  *
326  * These request entries should precede other shared resource entries
327  * such as vdevs, vrings.
328  */
329 OPENAMP_PACKED_BEGIN
330 struct fw_rsc_rproc_mem {
331         uint32_t type;
332         uint32_t da;
333         uint32_t pa;
334         uint32_t len;
335         uint32_t reserved;
336 } OPENAMP_PACKED_END;
338 /*
339  * struct fw_rsc_fw_chksum - firmware checksum
340  * @algo: algorithm to generate the cheksum
341  * @chksum: checksum of the firmware loadable sections.
342  *
343  * This resource entry provides checksum for the firmware loadable sections.
344  * It is used to check if the remote already runs with the expected firmware to
345  * decide if it needs to start the remote if the remote is already running.
346  */
347 OPENAMP_PACKED_BEGIN
348 struct fw_rsc_fw_chksum {
349         uint32_t type;
350         uint8_t algo[16];
351         uint8_t chksum[64];
352 } OPENAMP_PACKED_END;
354 /**
355  * struct remote_proc
356  *
357  * This structure is maintained by the remoteproc to represent the remote
358  * processor instance. This structure acts as a prime parameter to use
359  * the remoteproc APIs.
360  *
361  * @proc                : hardware interface layer processor control
362  * @rdev                : remote device , used by RPMSG "messaging" framework.
363  * @loader              : pointer remoteproc loader
364  * @channel_created     : create channel callback
365  * @channel_destroyed   : delete channel callback
366  * @default_cb          : default callback for channel
367  * @role                : remote proc role , RPROC_MASTER/RPROC_REMOTE
368  *
369  */
370 struct remote_proc {
371         struct hil_proc *proc;
372         struct remote_device *rdev;
373         struct remoteproc_loader *loader;
374         rpmsg_chnl_cb_t channel_created;
375         rpmsg_chnl_cb_t channel_destroyed;
376         rpmsg_rx_cb_t default_cb;
377         int role;
378 };
380 /**
381  * struct resc_table_info
382  *
383  * This structure is maintained by the remoteproc to allow applications
384  * to pass resource table info during remote initialization.
385  *
386  * @rsc_tab : pointer to resource table control block
387  * @size    : size of resource table.
388  *
389  */
390 struct rsc_table_info {
391         struct resource_table *rsc_tab;
392         int size;
393 };
395 /* Definitions for device types , null pointer, etc.*/
396 #define RPROC_SUCCESS                           0
397 #define RPROC_NULL                              (void *)0
398 #define RPROC_TRUE                              1
399 #define RPROC_FALSE                             0
400 #define RPROC_MASTER                            1
401 #define RPROC_REMOTE                            0
402 /* Number of msecs to wait for remote context to come up */
403 #define RPROC_BOOT_DELAY                        500
405 /* Remoteproc error codes */
406 #define RPROC_ERR_BASE                          -4000
407 #define RPROC_ERR_CPU_INIT                      (RPROC_ERR_BASE -1)
408 #define RPROC_ERR_NO_RSC_TABLE                  (RPROC_ERR_BASE -2)
409 #define RPROC_ERR_NO_MEM                        (RPROC_ERR_BASE -3)
410 #define RPROC_ERR_RSC_TAB_TRUNC                 (RPROC_ERR_BASE -4)
411 #define RPROC_ERR_RSC_TAB_VER                   (RPROC_ERR_BASE -5)
412 #define RPROC_ERR_RSC_TAB_RSVD                  (RPROC_ERR_BASE -6)
413 #define RPROC_ERR_RSC_TAB_VDEV_NRINGS           (RPROC_ERR_BASE -7)
414 #define RPROC_ERR_RSC_TAB_NP                    (RPROC_ERR_BASE -8)
415 #define RPROC_ERR_RSC_TAB_NS                    (RPROC_ERR_BASE -9)
416 #define RPROC_ERR_INVLD_FW                      (RPROC_ERR_BASE -10)
417 #define RPROC_ERR_LOADER                        (RPROC_ERR_BASE -11)
418 #define RPROC_ERR_PARAM                         (RPROC_ERR_BASE -12)
419 #define RPROC_ERR_PTR                           (void*)0xDEADBEAF
421 /**
422  * remoteproc_resource_init
423  *
424  * Initializes resources for remoteproc remote configuration.Only
425  * remoteproc remote applications are allowed to call this function.
426  *
427  * @param rsc_info          - pointer to resource table info control
428  *                            block
429  * @param proc              - pointer to the hil_proc
430  * @param channel_created   - callback function for channel creation
431  * @param channel_destroyed - callback function for channel deletion
432  * @param default_cb        - default callback for channel I/O
433  * @param rproc_handle      - pointer to new remoteproc instance
434  * @param init_env          - 1 to initialize environment, 0 not to
435  * @param rpmsg_role        - 1 for rpmsg master,  or 0 for rpmsg slave
436  *
437  * @param returns - status of execution
438  *
439  */
440 int remoteproc_resource_init(struct rsc_table_info *rsc_info,
441                             struct hil_proc *proc,
442                              rpmsg_chnl_cb_t channel_created,
443                              rpmsg_chnl_cb_t channel_destroyed,
444                              rpmsg_rx_cb_t default_cb,
445                              struct remote_proc **rproc_handle,
446                              int rpmsg_role);
448 /**
449  * remoteproc_resource_deinit
450  *
451  * Uninitializes resources for remoteproc remote configuration.
452  *
453  * @param rproc - pointer to remoteproc instance
454  *
455  * @param returns - status of execution
456  *
457  */
459 int remoteproc_resource_deinit(struct remote_proc *rproc);
461 /**
462  * remoteproc_init
463  *
464  * Initializes resources for remoteproc master configuration. Only
465  * remoteproc master applications are allowed to call this function.
466  *
467  * @param fw_name           - name of firmware
468  * @param proc              - pointer to hil_proc
469  * @param channel_created   - callback function for channel creation
470  * @param channel_destroyed - callback function for channel deletion
471  * @param default_cb        - default callback for channel I/O
472  * @param rproc_handle      - pointer to new remoteproc instance
473  *
474  * @param returns - status of function execution
475  *
476  */
477 int remoteproc_init(char *fw_name, struct hil_proc *proc,
478                     rpmsg_chnl_cb_t channel_created,
479                     rpmsg_chnl_cb_t channel_destroyed,
480                     rpmsg_rx_cb_t default_cb,
481                     struct remote_proc **rproc_handle);
483 /**
484  * remoteproc_deinit
485  *
486  * Uninitializes resources for remoteproc "master" configuration.
487  *
488  * @param rproc - pointer to remoteproc instance
489  *
490  * @param returns - status of function execution
491  *
492  */
493 int remoteproc_deinit(struct remote_proc *rproc);
495 /**
496  * remoteproc_boot
497  *
498  * This function loads the image on the remote processor and starts
499  * its execution from image load address.
500  *
501  * @param rproc - pointer to remoteproc instance to boot
502  *
503  * @param returns - status of function execution
504  */
505 int remoteproc_boot(struct remote_proc *rproc);
507 /**
508  * remoteproc_shutdown
509  *
510  * This function shutdowns the remote execution context.
511  *
512  * @param rproc - pointer to remoteproc instance to shutdown
513  *
514  * @param returns - status of function execution
515  */
516 int remoteproc_shutdown(struct remote_proc *rproc);
518 #endif                          /* REMOTEPROC_H_ */