Define a platform hook interface and cleanup misuse of private calls #61547

nashif · 2023-08-16T11:15:44Z

An attempt to cleanup misuse of private API call to define platform hooks and generalize the definition of hooks implemented by platforms overriding architecture implementation.

This also generalizes some hook implementations done for some architectures and made such implementation arch agnostic, allowing hooks to be implemented by any architecture.

Relates to #58007

gmarull

changes make sense to me. we should document reserved internal prefixes like arch, platform, etc. Some CI checks would also be nice to prevent misuses (e.g. forbid arch_/platform_ calls in samples/ or drivers/)

galak

any reason this can't be done with weak functions?

nashif · 2023-08-22T14:08:25Z

any reason this can't be done with weak functions?

This has been the approch for some interfaces. This PR is mostly changing the naming and moving a fewthings upo to the architecture level, but not changing how the interfaces are implemented.
We had a few change proposals floating around removing usage of _weak given it is considered not stanard but we still have many usages in the tree. Whether we use _weak or some other mechanism is something we need decide on separately I guess.

mbolivar-ampere · 2023-08-22T18:47:42Z

doc/hardware/porting/custom.rst

@@ -0,0 +1,16 @@
+.. _platform_cusomizations:
+
+Hardware with Custom Interfaces


Seems like a good first step towards closing the documentation gap between "board porting" and "soc" or "arch" porting.

github-actions · 2023-10-29T00:29:34Z

This pull request has been marked as stale because it has been open (more than) 60 days with no activity. Remove the stale label or add a comment saying that you would like to have the label removed otherwise this pull request will automatically be closed in 14 days. Note, that you can always re-open a closed pull request at any time.

amr-sc · 2023-12-07T09:26:43Z

any reason this can't be done with weak functions?

Is there a particular use for weak functions in this case?

Hi @cfriedt , I think the weak functions could be useful to override the default arch level implementations (which follow the Spec) in case some vendors doesn't conform to the Spec, or the Spec is ambiguous.

Sure - it's just that weak symbols are not part of ISO C or ISO C++ and are very much ELF specific.

We can achieve the same thing with a well-defined interface and having a Kconfig option to choose between the default (arch) and overridden (platform) solution.

Oh, I've got your point.
The explicit policy with default arch_ and overridden platform_ API is for sure better than the _weak approach.
Thanks!

P.S.: looks like this may provide a guideline for #65824 as well

Move from private to internal call. This should probably be promoted to an API and implementation abstracted similar to what we do with other cache functions. Signed-off-by: Anas Nashif <anas.nashif@intel.com>

use BIT macro where possible. Signed-off-by: Anas Nashif <anas.nashif@intel.com>

84b86d9 introduced the ability of defining custom sys_io functions for riscv. This is however useful for all other architectures and there is nothing riscv specific about it. So instead of having this be riscv specific, move implementation to the common architecture code and make it available for everyone using PLATFORM_HAS_CUSTOM_SYS_IO. Signed-off-by: Anas Nashif <anas.nashif@intel.com>

Move from private hook names to internal using a common prefix for platform hooks. Signed-off-by: Anas Nashif <anas.nashif@intel.com>

Use platform_ instead of z_soc_ and make the feature generic supporting all architectures with CONFIG_PLATFORM_HAS_CUSTOM_IRQ_LOCK_OPS. Signed-off-by: Anas Nashif <anas.nashif@intel.com>

This call is not being used anywhere. Signed-off-by: Anas Nashif <anas.nashif@intel.com>

Rename platform hooks enabled with Kconfig from z_soc_ to platform_. Move from private hook names to internal using a common prefix for platform hooks. Signed-off-by: Anas Nashif <anas.nashif@intel.com>

Define a set of platform hooks. Signed-off-by: Anas Nashif <anas.nashif@intel.com>

Update with some fixes to API usage. Signed-off-by: Anas Nashif <anas.nashif@intel.com>

Although this option is now being used only by ARM, it is needed by other architectures, so make it global and change all occurances. Signed-off-by: Anas Nashif <anas.nashif@intel.com>

group all custom interface configs into one menu. Signed-off-by: Anas Nashif <anas.nashif@intel.com>

Rename all z_/z_arm_ call for setting irq priority to a new architecture interface shared by all architectures. Signed-off-by: Anas Nashif <anas.nashif@intel.com>

define additional routines that can be shared by other architectures. Right now this is only for ARM and will be moved up in the future. Signed-off-by: Anas Nashif <anas.nashif@intel.com>

Reorganize functions in header file for better fit. Signed-off-by: Anas Nashif <anas.nashif@intel.com>

To allow other interrupt controllers to be called. Signed-off-by: Anas Nashif <anas.nashif@intel.com>

nashif · 2023-12-13T14:59:06Z

the more I look into things and try to fix existing inconsistencies and interfaces, I realize how messy interrupt implementation is and how many ways exist to enable interrupt controllers that we need to fix ASAP, so for example, I do not think we need to support platform specific irq handling as this PR does and instead allow for this to be done using dedicated interrupt drivers, the same way we do this already on many architectures.

aescolar · 2023-12-13T14:57:03Z

doc/hardware/porting/custom.rst

+When the provided support in Zephyr does not cover certain hardware platforms,
+some interfaces can be implemented directly by the platform or a custom
+architecture interface can be used and resulting in more flexibility and
+hardware support of differebt variants of the same hardware.


typo differebt

aescolar · 2023-12-13T14:57:30Z

doc/hardware/porting/custom.rst

+
+When the provided support in Zephyr does not cover certain hardware platforms,
+some interfaces can be implemented directly by the platform or a custom
+architecture interface can be used and resulting in more flexibility and


".. can be used and resulting .."
This whole sentence is a bit too tough to read.

nashif · 2023-12-13T18:52:38Z

the more I look into things and try to fix existing inconsistencies and interfaces, I realize how messy interrupt implementation is and how many ways exist to enable interrupt controllers that we need to fix ASAP, so for example, I do not think we need to support platform specific irq handling as this PR does and instead allow for this to be done using dedicated interrupt drivers, the same way we do this already on many architectures.

just seen this #66505

github-actions · 2024-02-12T00:30:05Z

This pull request has been marked as stale because it has been open (more than) 60 days with no activity. Remove the stale label or add a comment saying that you would like to have the label removed otherwise this pull request will automatically be closed in 14 days. Note, that you can always re-open a closed pull request at any time.

github-actions · 2024-04-15T02:42:20Z

This pull request has been marked as stale because it has been open (more than) 60 days with no activity. Remove the stale label or add a comment saying that you would like to have the label removed otherwise this pull request will automatically be closed in 14 days. Note, that you can always re-open a closed pull request at any time.

ycsin · 2024-06-26T13:35:27Z

@nashif any update for this PR?

nashif added the Architecture Review Discussion in the Architecture WG required label Aug 16, 2023

carlescufi requested a review from gmarull August 16, 2023 11:38

nashif changed the title ~~Define a platform hook interface and cleanup misused of private calls~~ Define a platform hook interface and cleanup misuse of private calls Aug 16, 2023

gmarull reviewed Aug 16, 2023

View reviewed changes

galak reviewed Aug 22, 2023

View reviewed changes

mbolivar-ampere reviewed Aug 22, 2023

View reviewed changes

github-actions bot added the Stale label Oct 29, 2023

nashif removed the Stale label Oct 31, 2023

nashif force-pushed the soc_calls branch from 3d39e5d to 3d3f030 Compare November 29, 2023 12:32

nashif marked this pull request as ready for review November 29, 2023 12:32

zephyrbot added area: ARM ARM (32-bit) Architecture platform: NXP NXP area: RISCV RISCV Architecture (32-bit & 64-bit) platform: Intel ADSP Intel Audio platforms area: Xtensa Xtensa Architecture area: Memory Management area: Architectures area: ARM64 ARM (64-bit) Architecture labels Nov 29, 2023

zephyrbot requested review from aborisovich, andyross, ceolin, dcpleung, jxstelter, kv2019i, lgirdwood, lyakh, marc-hb and marcinszkudlinski November 29, 2023 12:33

nashif added 16 commits December 13, 2023 06:34

xtensa: cache: z_soc_cached_ptr -> arch_xtensa_cached_ptr

2b4c469

Move from private to internal call. This should probably be promoted to an API and implementation abstracted similar to what we do with other cache functions. Signed-off-by: Anas Nashif <anas.nashif@intel.com>

xtensa: irq: use BIT

549d79c

use BIT macro where possible. Signed-off-by: Anas Nashif <anas.nashif@intel.com>

sys_io: rename z_soc_sys_ -> platform_sysio_

0317b4c

Move from private hook names to internal using a common prefix for platform hooks. Signed-off-by: Anas Nashif <anas.nashif@intel.com>

arch: interrupts: rename z_soc_* to platform_*

793a827

Move from private hook names to internal using a common prefix for platform hooks. Signed-off-by: Anas Nashif <anas.nashif@intel.com>

arch: riscv: Move interrupt platform hooks to use platform_ prefix.

0c2d151

Use platform_ instead of z_soc_ and make the feature generic supporting all architectures with CONFIG_PLATFORM_HAS_CUSTOM_IRQ_LOCK_OPS. Signed-off-by: Anas Nashif <anas.nashif@intel.com>

xtensa: remove unused z_soc_irq_init

ab87fca

This call is not being used anywhere. Signed-off-by: Anas Nashif <anas.nashif@intel.com>

arch: arm: use platform_ for platform hooks

d3caab0

Rename platform hooks enabled with Kconfig from z_soc_ to platform_. Move from private hook names to internal using a common prefix for platform hooks. Signed-off-by: Anas Nashif <anas.nashif@intel.com>

doc: document custom platform interfaces

495fb8b

Define a set of platform hooks. Signed-off-by: Anas Nashif <anas.nashif@intel.com>

manifest: update sof sha

f5b20b8

Update with some fixes to API usage. Signed-off-by: Anas Nashif <anas.nashif@intel.com>

arch: rename ARM_CUSTOM_INTERRUPT_CONTROLLER and make global

f1f2c02

Although this option is now being used only by ARM, it is needed by other architectures, so make it global and change all occurances. Signed-off-by: Anas Nashif <anas.nashif@intel.com>

arch: kconfig move platform overrides together

6cbd540

group all custom interface configs into one menu. Signed-off-by: Anas Nashif <anas.nashif@intel.com>

arch: standarize *_irq_priority_set into arch_irq_priority_set

c8de8f8

Rename all z_/z_arm_ call for setting irq priority to a new architecture interface shared by all architectures. Signed-off-by: Anas Nashif <anas.nashif@intel.com>

arch: irq: define more arch_irq_ routines

c568b7c

define additional routines that can be shared by other architectures. Right now this is only for ARM and will be moved up in the future. Signed-off-by: Anas Nashif <anas.nashif@intel.com>

doc: reorg arch interface documentation

8409aaa

Reorganize functions in header file for better fit. Signed-off-by: Anas Nashif <anas.nashif@intel.com>

arch: arm: do not call arm_gic intc directly, abstract with arch_irq

bb8718d

To allow other interrupt controllers to be called. Signed-off-by: Anas Nashif <anas.nashif@intel.com>

nashif force-pushed the soc_calls branch from 28fda0d to bb8718d Compare December 13, 2023 14:51

nashif requested a review from ruuddw as a code owner December 13, 2023 14:51

aescolar reviewed Dec 13, 2023

View reviewed changes

luchnikov mentioned this pull request Dec 13, 2023

arch: riscv: Add support for custom SOC IPI, per-core init #65824

Open

github-actions bot added the Stale label Feb 12, 2024

nashif removed the Stale label Feb 14, 2024

github-actions bot added the Stale label Apr 15, 2024

github-actions bot closed this Apr 30, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Define a platform hook interface and cleanup misuse of private calls #61547

Define a platform hook interface and cleanup misuse of private calls #61547

nashif commented Aug 16, 2023 •

edited

Loading

gmarull left a comment

galak left a comment

nashif commented Aug 22, 2023

mbolivar-ampere Aug 22, 2023

github-actions bot commented Oct 29, 2023

amr-sc commented Dec 7, 2023

nashif commented Dec 13, 2023

aescolar Dec 13, 2023

aescolar Dec 13, 2023

nashif commented Dec 13, 2023

github-actions bot commented Feb 12, 2024

github-actions bot commented Apr 15, 2024

ycsin commented Jun 26, 2024

		@@ -0,0 +1,16 @@
		.. _platform_cusomizations:

		Hardware with Custom Interfaces

Define a platform hook interface and cleanup misuse of private calls #61547

Define a platform hook interface and cleanup misuse of private calls #61547

Conversation

nashif commented Aug 16, 2023 • edited Loading

gmarull left a comment

Choose a reason for hiding this comment

galak left a comment

Choose a reason for hiding this comment

nashif commented Aug 22, 2023

mbolivar-ampere Aug 22, 2023

Choose a reason for hiding this comment

github-actions bot commented Oct 29, 2023

amr-sc commented Dec 7, 2023

nashif commented Dec 13, 2023

aescolar Dec 13, 2023

Choose a reason for hiding this comment

aescolar Dec 13, 2023

Choose a reason for hiding this comment

nashif commented Dec 13, 2023

github-actions bot commented Feb 12, 2024

github-actions bot commented Apr 15, 2024

ycsin commented Jun 26, 2024

nashif commented Aug 16, 2023 •

edited

Loading