From 7cfdb748b59a768604a540185cbc42529e69dc5b Mon Sep 17 00:00:00 2001 From: marif-nexthop Date: Mon, 25 Aug 2025 13:04:46 -0700 Subject: [PATCH 1/2] ISS-2933: Update FBOSS documentation to add RPM package installation information. (#43) #### Why I did it FBOSS documentation had information about BSP source structure including RPM package but did not have information about install location of the contents of the RPM package. #### How I did it -Update FBOSS documentation to add RPM package installation information. #### How to verify it #### Which release branch to backport - [ ] 202411 --- .../platform/bsp_development_requirements.md | 32 +++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/docs/docs/platform/bsp_development_requirements.md b/docs/docs/platform/bsp_development_requirements.md index 9504706aa71ce..d7196500f7c08 100644 --- a/docs/docs/platform/bsp_development_requirements.md +++ b/docs/docs/platform/bsp_development_requirements.md @@ -203,6 +203,38 @@ The "rpmbuild" directory must have a file named `\_bsp_kmods.spec` whic an rpm spec file. This spec file should result in an rpm that conforms to the rest of the specifications in this document +### 4.2 RPM Package Installation Requirements + +The BSP RPM must install files to specific locations for proper integration with +the FBOSS platform management system. + +#### 4.2.1 Kernel Module Installation + +Kernel modules must be installed in the standard kernel module path: + +``` +/lib/modules//extra/ +``` + +This ensures proper integration with the Linux kernel module loading system and +allows `depmod` to correctly resolve module dependencies. + +#### 4.2.2 BSP Utility Files Installation + +The BSP utility files must be installed in a vendor-specific directory structure: + +``` +/usr/local/_bsp//kmods.json +/usr/local/_bsp//fbsp-remove.sh +``` + +Where: +- `` is extracted from the RPM name (e.g., "fboss", "arista", "cisco", "nexthop") +- `` is the target kernel version (e.g., "6.4.3-0_fbk1_755_ga25447393a1d") + +The Platform Manager uses this path structure to locate and manage BSP components +during installation, upgrade, and removal operations. + ## 5. The PCIe FPGA Driver Most I/O (I2C, SPI, etc) Controllers are provided by the PCIe FPGA in the FBOSS From 64cc9612e6c41aefba27c9f616ded48baca5c1a8 Mon Sep 17 00:00:00 2001 From: Arif Date: Thu, 28 Aug 2025 12:22:04 -0700 Subject: [PATCH 2/2] Removed vendor names. --- docs/docs/platform/bsp_development_requirements.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/platform/bsp_development_requirements.md b/docs/docs/platform/bsp_development_requirements.md index d7196500f7c08..96ecd9f47c018 100644 --- a/docs/docs/platform/bsp_development_requirements.md +++ b/docs/docs/platform/bsp_development_requirements.md @@ -229,7 +229,7 @@ The BSP utility files must be installed in a vendor-specific directory structure ``` Where: -- `` is extracted from the RPM name (e.g., "fboss", "arista", "cisco", "nexthop") +- `` is extracted from the RPM name - `` is the target kernel version (e.g., "6.4.3-0_fbk1_755_ga25447393a1d") The Platform Manager uses this path structure to locate and manage BSP components