diff options
| author | Anup Patel <apatel@ventanamicro.com> | 2022-08-08 07:04:31 +0300 |
|---|---|---|
| committer | Anup Patel <anup@brainfault.org> | 2022-08-08 07:04:31 +0300 |
| commit | 0723bab8fe073ccbbb45e85e0d50ec1d2055d34a (patch) | |
| tree | 2f47e2327c85fbca589be4528419ea9aa9dcfd78 /docs/platform_guide.md | |
| parent | eccb9df5cf402dd910efc5f3b926db5161a318bf (diff) | |
| download | opensbi-0723bab8fe073ccbbb45e85e0d50ec1d2055d34a.tar.xz | |
docs: Update documentation for kconfig support
We update all documentation files to:
1) Remove references to platform specific config.mk file since it is
has been removed.
2) Add details about platform specific configs/defconfig and Kconfig
files mandatory for each platform.
3) Add required packages in top-level README.md
4) Fix typo releated to object.mk in docs/platform/platform.md
Signed-off-by: Anup Patel <apatel@ventanamicro.com>
Reviewed-by: Andrew Jones <ajones@ventanamicro.com>
Tested-by: Andrew Jones <ajones@ventanamicro.com>
Acked-by: Atish Patra <atishp@rivosinc.com>
Tested-by: Atish Patra <atishp@rivosinc.com>
Diffstat (limited to 'docs/platform_guide.md')
| -rw-r--r-- | docs/platform_guide.md | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/docs/platform_guide.md b/docs/platform_guide.md index b6c2c2e..38fd516 100644 --- a/docs/platform_guide.md +++ b/docs/platform_guide.md @@ -28,11 +28,12 @@ Adding support for a new platform Support for a new platform named *<xyz>* can be added as follows: 1. Create a directory named *<xyz>* under the *platform/* directory. -2. Create a platform configuration file named *config.mk* under the - *platform/<xyz>/* directory. This configuration file will provide +2. Create platform configuration files named *Kconfig* and *configs/defconfig* + under the *platform/<xyz>/* directory. These configuration files will + provide the build time configuration for the sources to be compiled. +3. Create a *platform/<xyz>/objects.mk* file for listing the platform + object files to be compiled. This file also provides platform-specific compiler flags, and select firmware options. -3. Create a *platform/<xyz>/objects.mk* file for listing the - platform-specific object files to be compiled. 4. Create a *platform/<xyz>/platform.c* file providing a *struct sbi_platform* instance. |