Skip to content

Update FBOSS documentation to add RPM package installation information #525

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.

Sign up for GitHub

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
wants to merge 2 commits into from
+32 −0
Closed

Update FBOSS documentation to add RPM package installation information #525

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7cfdb74
ISS-2933: Update FBOSS documentation to add RPM package installation …
marif-nexthop Aug 25, 2025
64cc961
Removed vendor names.
marif-nexthop Aug 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions docs/docs/platform/bsp_development_requirements.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,38 @@ The "rpmbuild" directory must have a file named `<vendor\>\_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/<kernel-version>/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/<vendor>_bsp/<kernel-version>/kmods.json
/usr/local/<vendor>_bsp/<kernel-version>/fbsp-remove.sh
```

Where:
- `<vendor>` is extracted from the RPM name (e.g., "fboss", "arista", "cisco", "nexthop")
- `<kernel-version>` 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
Expand Down