mirror of
https://github.com/ARM-software/arm-trusted-firmware.git
synced 2025-08-17 09:57:01 +02:00
09d40e0e08
Enforce full include path for includes. Deprecate old paths.
The following folders inside include/lib have been left unchanged:
- include/lib/cpus/${ARCH}
- include/lib/el3_runtime/${ARCH}
The reason for this change is that having a global namespace for
includes isn't a good idea. It defeats one of the advantages of having
folders and it introduces problems that are sometimes subtle (because
you may not know the header you are actually including if there are two
of them).
For example, this patch had to be created because two headers were
called the same way: e0ea0928d5 ("Fix gpio includes of mt8173 platform
to avoid collision."). More recently, this patch has had similar
problems: 46f9b2c3a2 ("drivers: add tzc380 support").
This problem was introduced in commit 4ecca33988 ("Move include and
source files to logical locations"). At that time, there weren't too
many headers so it wasn't a real issue. However, time has shown that
this creates problems.
Platforms that want to preserve the way they include headers may add the
removed paths to PLAT_INCLUDES, but this is discouraged.
Change-Id: I39dc53ed98f9e297a5966e723d1936d6ccf2fc8f
Signed-off-by: Antonio Nino Diaz <antonio.ninodiaz@arm.com>
89 lines
2.5 KiB
C
89 lines
2.5 KiB
C
/*
|
|
* Copyright (c) 2017-2018, ARM Limited and Contributors. All rights reserved.
|
|
*
|
|
* SPDX-License-Identifier: BSD-3-Clause
|
|
*/
|
|
|
|
#ifndef PUBSUB_H
|
|
#define PUBSUB_H
|
|
|
|
#define __pubsub_start_sym(event) __pubsub_##event##_start
|
|
#define __pubsub_end_sym(event) __pubsub_##event##_end
|
|
|
|
#ifdef __LINKER__
|
|
|
|
/* For the linker ... */
|
|
|
|
#define __pubsub_section(event) __pubsub_##event
|
|
|
|
/*
|
|
* REGISTER_PUBSUB_EVENT has a different definition between linker and compiler
|
|
* contexts. In linker context, this collects pubsub sections for each event,
|
|
* placing guard symbols around each.
|
|
*/
|
|
#define REGISTER_PUBSUB_EVENT(event) \
|
|
__pubsub_start_sym(event) = .; \
|
|
KEEP(*(__pubsub_section(event))); \
|
|
__pubsub_end_sym(event) = .
|
|
|
|
#else /* __LINKER__ */
|
|
|
|
/* For the compiler ... */
|
|
|
|
#include <assert.h>
|
|
#include <cdefs.h>
|
|
#include <stddef.h>
|
|
|
|
#include <arch_helpers.h>
|
|
|
|
#define __pubsub_section(event) __section("__pubsub_" #event)
|
|
|
|
/*
|
|
* In compiler context, REGISTER_PUBSUB_EVENT declares the per-event symbols
|
|
* exported by the linker required for the other pubsub macros to work.
|
|
*/
|
|
#define REGISTER_PUBSUB_EVENT(event) \
|
|
extern pubsub_cb_t __pubsub_start_sym(event)[]; \
|
|
extern pubsub_cb_t __pubsub_end_sym(event)[]
|
|
|
|
/*
|
|
* Have the function func called back when the specified event happens. This
|
|
* macro places the function address into the pubsub section, which is picked up
|
|
* and invoked by the invoke_pubsubs() function via. the PUBLISH_EVENT* macros.
|
|
*
|
|
* The extern declaration is there to satisfy MISRA C-2012 rule 8.4.
|
|
*/
|
|
#define SUBSCRIBE_TO_EVENT(event, func) \
|
|
extern pubsub_cb_t __cb_func_##func##event __pubsub_section(event); \
|
|
pubsub_cb_t __cb_func_##func##event __pubsub_section(event) = (func)
|
|
|
|
/*
|
|
* Iterate over subscribed handlers for a defined event. 'event' is the name of
|
|
* the event, and 'subscriber' a local variable of type 'pubsub_cb_t *'.
|
|
*/
|
|
#define for_each_subscriber(event, subscriber) \
|
|
for (subscriber = __pubsub_start_sym(event); \
|
|
subscriber < __pubsub_end_sym(event); \
|
|
subscriber++)
|
|
|
|
/*
|
|
* Publish a defined event supplying an argument. All subscribed handlers are
|
|
* invoked, but the return value of handlers are ignored for now.
|
|
*/
|
|
#define PUBLISH_EVENT_ARG(event, arg) \
|
|
do { \
|
|
pubsub_cb_t *subscriber; \
|
|
for_each_subscriber(event, subscriber) { \
|
|
(*subscriber)(arg); \
|
|
} \
|
|
} while (0)
|
|
|
|
/* Publish a defined event with NULL argument */
|
|
#define PUBLISH_EVENT(event) PUBLISH_EVENT_ARG(event, NULL)
|
|
|
|
/* Subscriber callback type */
|
|
typedef void* (*pubsub_cb_t)(const void *arg);
|
|
|
|
#endif /* __LINKER__ */
|
|
#endif /* PUBSUB_H */
|