2019-09-20 17:41:38 +08:00
|
|
|
/*
|
|
|
|
|
* Copyright (c) 2020 STMicroelectronics
|
|
|
|
|
*
|
|
|
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* In addition to the standard ELF segments, most remote processors would
|
|
|
|
|
* also include a special section which we call "the resource table".
|
|
|
|
|
*
|
|
|
|
|
* The resource table contains system resources that the remote processor
|
|
|
|
|
* requires before it should be powered on, such as allocation of physically
|
|
|
|
|
* contiguous memory, or iommu mapping of certain on-chip peripherals.
|
|
|
|
|
|
|
|
|
|
* In addition to system resources, the resource table may also contain
|
|
|
|
|
* resource entries that publish the existence of supported features
|
|
|
|
|
* or configurations by the remote processor, such as trace buffers and
|
|
|
|
|
* supported virtio devices (and their configurations).
|
|
|
|
|
|
|
|
|
|
* Dependencies:
|
|
|
|
|
* to be compliant with Linux kernel OS the resource table must be linked in a
|
|
|
|
|
* specific section named ".resource_table".
|
|
|
|
|
|
|
|
|
|
* Related documentation:
|
|
|
|
|
* https://www.kernel.org/doc/Documentation/remoteproc.txt
|
|
|
|
|
* https://github.com/OpenAMP/open-amp/wiki/OpenAMP-Life-Cycle-Management
|
|
|
|
|
*/
|
|
|
|
|
|
includes: prefer <zephyr/kernel.h> over <zephyr/zephyr.h>
As of today <zephyr/zephyr.h> is 100% equivalent to <zephyr/kernel.h>.
This patch proposes to then include <zephyr/kernel.h> instead of
<zephyr/zephyr.h> since it is more clear that you are including the
Kernel APIs and (probably) nothing else. <zephyr/zephyr.h> sounds like a
catch-all header that may be confusing. Most applications need to
include a bunch of other things to compile, e.g. driver headers or
subsystem headers like BT, logging, etc.
The idea of a catch-all header in Zephyr is probably not feasible
anyway. Reason is that Zephyr is not a library, like it could be for
example `libpython`. Zephyr provides many utilities nowadays: a kernel,
drivers, subsystems, etc and things will likely grow. A catch-all header
would be massive, difficult to keep up-to-date. It is also likely that
an application will only build a small subset. Note that subsystem-level
headers may use a catch-all approach to make things easier, though.
NOTE: This patch is **NOT** removing the header, just removing its usage
in-tree. I'd advocate for its deprecation (add a #warning on it), but I
understand many people will have concerns.
Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-08-25 15:58:46 +08:00
|
|
|
#include <zephyr/kernel.h>
|
2019-09-20 17:41:38 +08:00
|
|
|
#include <resource_table.h>
|
|
|
|
|
|
|
|
|
|
extern char ram_console[];
|
|
|
|
|
|
|
|
|
|
#define __resource Z_GENERIC_SECTION(.resource_table)
|
|
|
|
|
|
|
|
|
|
static struct fw_resource_table __resource resource_table = {
|
|
|
|
|
.ver = 1,
|
|
|
|
|
.num = RSC_TABLE_NUM_ENTRY,
|
|
|
|
|
.offset = {
|
|
|
|
|
|
|
|
|
|
#if (CONFIG_OPENAMP_RSC_TABLE_NUM_RPMSG_BUFF > 0)
|
|
|
|
|
offsetof(struct fw_resource_table, vdev),
|
|
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
#if defined(CONFIG_RAM_CONSOLE)
|
|
|
|
|
offsetof(struct fw_resource_table, cm_trace),
|
|
|
|
|
#endif
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
#if (CONFIG_OPENAMP_RSC_TABLE_NUM_RPMSG_BUFF > 0)
|
|
|
|
|
/* Virtio device entry */
|
|
|
|
|
.vdev = {
|
|
|
|
|
RSC_VDEV, VIRTIO_ID_RPMSG, 0, RPMSG_IPU_C0_FEATURES, 0, 0, 0,
|
|
|
|
|
VRING_COUNT, {0, 0},
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
/* Vring rsc entry - part of vdev rsc entry */
|
|
|
|
|
.vring0 = {VRING_TX_ADDRESS, VRING_ALIGNMENT,
|
|
|
|
|
CONFIG_OPENAMP_RSC_TABLE_NUM_RPMSG_BUFF,
|
|
|
|
|
VRING0_ID, 0},
|
|
|
|
|
.vring1 = {VRING_RX_ADDRESS, VRING_ALIGNMENT,
|
|
|
|
|
CONFIG_OPENAMP_RSC_TABLE_NUM_RPMSG_BUFF,
|
|
|
|
|
VRING1_ID, 0},
|
|
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
#if defined(CONFIG_RAM_CONSOLE)
|
|
|
|
|
.cm_trace = {
|
|
|
|
|
RSC_TRACE,
|
|
|
|
|
(uint32_t)ram_console, CONFIG_RAM_CONSOLE_BUFFER_SIZE + 1, 0,
|
|
|
|
|
"Zephyr_log",
|
|
|
|
|
},
|
|
|
|
|
#endif
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
void rsc_table_get(void **table_ptr, int *length)
|
|
|
|
|
{
|
|
|
|
|
*table_ptr = (void *)&resource_table;
|
|
|
|
|
*length = sizeof(resource_table);
|
|
|
|
|
}
|