Skip to content

doc: Adding documentation for porting a new SoC #33108

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
burumaj opened this issue Mar 7, 2021 · 6 comments · Fixed by #69475
Closed

doc: Adding documentation for porting a new SoC #33108

burumaj opened this issue Mar 7, 2021 · 6 comments · Fixed by #69475
Assignees
Labels
area: Documentation Enhancement Changes/Updates/Additions to existing features

Comments

@burumaj
Copy link
Contributor

burumaj commented Mar 7, 2021

Is your enhancement proposal related to a problem? Please describe.
Missing documentation on porting a new SoC to Zephyr. The lack of of this documentation
poses a significant hurdle for people not super familiar with this part of the process.

Describe the solution you'd like
The solution I would like to see is porting guide for a new SoC similar to the porting guides
for new architectures, boards and shields (located here).

As far as I can tell for now, this should at least include where Kconfig looks for certain configuration options.
For example to select a new family of SoC Kconfig sources soc/<arch>/<family>/Kconfig.soc.

Describe alternatives you've considered
Right now the only alternative i can see is the laborious process of following the way other families and series of
SoC's are ported. This is made more difficult since not every family and series follows the same naming conventions.

Additional context
This was all encountered while working on a SoC port for the RP2040

@burumaj burumaj added the Enhancement Changes/Updates/Additions to existing features label Mar 7, 2021
@burumaj
Copy link
Contributor Author

burumaj commented Mar 7, 2021

@K2AAE
Copy link

K2AAE commented Mar 8, 2021

Dead end: "This presentation will not cover how to add a new CPU core architecture support. But a good documentation on how to achieve this can be find here;" and "here" takes you to https://docs.zephyrproject.org/latest/porting/arch.html which returns Sorry, Page Not Found. I've found hunting down answers on Zephyr to be endless loops, nRF stuff a good example of lazy.

@burumaj
Copy link
Contributor Author

burumaj commented Mar 11, 2021

The docs for porting a new architecture can be found here (https://docs.zephyrproject.org/latest/guides/porting/arch.html). This is more related to adding a new SoC based on an already supported architecture.

@gudnimg
Copy link
Contributor

gudnimg commented Mar 24, 2021

I find the documentation here (in the board porting guide) could be improved for new users (like myself):

Start by making sure your SoC is supported by Zephyr

I think it will be helpful for everyone to at least include some links here if some exist to help save time.
image

@zephyrbot
Copy link
Collaborator

Hi @kartben, @carlescufi,

This issue, marked as an Enhancement, was opened a while ago and did not get any traction. It was just assigned to you based on the labels. If you don't consider yourself the right person to address this issue, please re-assing it to the right person.

Please take a moment to review if the issue is still relevant to the project. If it is, please provide feedback and direction on how to move forward. If it is not, has already been addressed, is a duplicate, or is no longer relevant, please close it with a short comment explaining the reason.

@burumaj you are also encouraged to help moving this issue forward by providing additional information and confirming this request/issue is still relevant to you.

Thanks!

@kartben
Copy link
Collaborator

kartben commented May 24, 2025

Fixed with #69475

@kartben kartben linked a pull request May 24, 2025 that will close this issue
@kartben kartben closed this as completed May 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: Documentation Enhancement Changes/Updates/Additions to existing features
Projects
Development

Successfully merging a pull request may close this issue.

7 participants