SkiBoot Documentation

Overview

• Skiboot overview
  • Source layout
  • Binaries
  • Booting
  • OS interface
  • Interrupts
  • Memory
  • Skiboot log
• OPAL Specification
  • Authors
  • Definitions
  • What is OPAL?
  • Boot Services
  • Payload Environment
  • Runtime Services
  • Detecting OPAL Support
  • OPAL log
• Supported platforms & CPUs
  • CPUs
  • Platforms
  • Dropped Platforms

Development Process

• Development and Release Process
  • Lifecycle of a patch
  • On closed source branches and forks
  • License
• Contributing to skiboot
  • Development Environment
  • Developer Certificate of Origin
• Skiboot stable tree rules and releases
  • What patches are accepted?
  • HOWTO submit to stable
  • Trees
• Versioning Scheme of skiboot
  • History
  • Current practice
  • Practical Considerations

Developer Guide and Internals

• SkiBoot Console Log
  • Log levels
  • Debugging
• How to log errors on OPAL
  • Error logging interfaces in OPAL
• Error logging retrieval from FSP:
  • Design constraints:
  • Note
  • Sample error logging
  • Sample output PEL dump got from FSP
• OPAL <–> BMC interactions
  • IPMI sensors
  • Chassis control messages
  • Watchdog support
  • Real-time clock
  • SBE validation
• GCOV for skiboot
  • Unit tests
  • Skiboot
  • Building Skiboot with GCOV
  • Extracting GCOV data
• Memory in skiboot
  • HEAP
• OPAL/Skiboot Nvlink Interface Documentation
  • Overview
  • Emulated PCI Devices
  • Device Tree Bindings
• PCI
  • Debugging
  • IODA PE Setup Sequences
  • IODA MMIO Setup Sequences
  • IODA MSI Setup Sequences
  • IODA DMA Setup Sequences
  • Device Tree Bindings
• PCI Slots
  • PCI Slot Operations
• PCI Slot Properties
  • PCI Hotplug
  • PCI Slot on Apollo and Firenze
• XSCOM Bindings
  • XSCOM regions
  • ECID
  • Chiplet endpoints
• P9 XIVE Exploitation
  • I - Device-tree updates
  • II - General operations
  • III - Event queues
  • IV - OPAL APIs
• OPAL/Skiboot In-Memory Collection (IMC) interface Documentation
  • Overview:
  • Nest (On-Chip, Off-Core) unit:
  • Core unit:
  • Trace mode of IMC:
  • OPAL APIs:
• Power Management
  • Debugging
• MPIPL (aka FADUMP) Overview
  • Registration
  • Initiating dump
  • Dump collection
  • MPIPL boot
  • Device tree
• Virtual Accelerator Switchboard (VAS)

OPAL ABI

• Secure and Trusted Boot Library (LibSTB) Documentation
  • Secure Boot
  • Container Verification Code
  • Trusted Boot
• Device Tree
  • General comments
  • Reserve Map
  • Root Node
• Device Tree
  • ibm,cvc
  • ibm,firmware-versions node
  • ibm,opal
  • ibm,secureboot
  • IMC Device Tree Bindings
  • P9 memory hierarchy
  • Nvlink Device Tree Bindings
  • Nest (NX) Accelerator Coprocessor
  • OpenCAPI Device Tree Bindings
  • PCI Device Tree Bindings
  • reserved-memory device tree nodes
  • Trusted Platform Module (TPM)
  • Virtual Accelerator Switchboard (VAS)
  • VPD (Vital Product Data)
  • ibm,powerpc-cpu-features Binding
  • ibm,powerpc-cpu-features Design
• OPAL API Documentation
  • OPAL_CEC_POWER_DOWN
  • OPAL_CEC_REBOOT and OPAL_CEC_REBOOT2
  • OPAL_CHECK_ASYNC_COMPLETION
  • OPAL_CHECK_TOKEN
  • Code Update on FSP based machine
  • OPAL_CONFIG_CPU_IDLE_STATE
  • OPAL Console calls
  • OPAL Dumps
  • OPAL_ELOG: Error logging
  • OPAL Flash calls
  • OPAL_GET_DEVICE_TREE
  • OPAL_GET_EPOW_STATUS
  • OPAL_GET_MSG
  • OPAL_GET_MSI_32 and OPAL_GET_MSI_64
  • OPAL_GET_XIVE
  • Hypervisor Maintenance Interrupt (HMI)
  • List of errors that causes HMI
  • HMI handling
  • OPAL_HANDLE_HMI
  • OPAL_HANDLE_HMI2
  • OPAL_HANDLE_INTERRUPT
  • OPAL_I2C_REQUEST
  • OPAL_IMC_COUNTERS_INIT
  • OPAL_IMC_COUNTERS_START
  • OPAL_IMC_COUNTERS_STOP
  • OPAL_INT_EOI
  • OPAL_INT_GET_XIRR
  • OPAL_INT_SET_CPPR
  • OPAL_INT_SET_MFRR
  • OPAL_INVALID_CALL
  • OPAL_IPMI_SEND
  • OPAL_IPMI_RECV
  • Service Indicators (LEDS)
  • OPAL_LPC_READ
  • OPAL_LPC_WRITE
  • OPAL_MESSAGE
  • OPAL MPIPL APIs
  • OPAL_MPIPL_UPDATE
  • OPAL_MPIPL_REGISTER_TAG
  • OPAL_MPIPL_QUERY_TAG
  • OPAL_NMMU_SET_PTCR
  • OPAL NPU2 calls
  • OPAL_NPU_SET_RELAXED_ORDER
  • OPAL_NPU_GET_RELAXED_ORDER
  • OPAL_NPU_SPA_SETUP
  • OPAL_NPU_SPA_CLEAR_CACHE
  • OPAL_NPU_TL_SET
  • OPAL_NPU_MEM_ALLOC
  • OPAL_NPU_MEM_RELEASE
  • OPAL NVRAM
  • Get/Set System Parameters
  • OPAL PCI Config Space Access
  • OPAL_PCI_EEH_FREEZE_CLEAR
  • OPAL_PCI_EEH_FREEZE_SET
  • OPAL_PCI_EEH_FREEZE_STATUS
  • OPAL_PCI_EEH_FREEZE_STATUS2
  • OPAL_PCI_ERR_INJECT
  • OPAL_PCI_GET_HUB_DIAG_DATA
  • OPAL_PCI_GET_PHB_DIAG_DATA2
  • OPAL_PCI_GET_POWER_STATE
  • OPAL_PCI_GET_PRESENCE_STATE
  • OPAL_PCI_GET_PBCQ_TUNNEL_BAR
  • OPAL_PCI_SET_PBCQ_TUNNEL_BAR
  • OPAL_PCI_MAP_PE_DMA_WINDOW
  • OPAL_PCI_MAP_PE_DMA_WINDOW_REAL
  • OPAL_PCI_MAP_PE_MMIO_WINDOW
  • OPAL_PCI_MSI_EOI
  • OPAL_PCI_NEXT_ERROR
  • OPAL_PCI_PHB_MMIO_ENABLE
  • OPAL_PCI_POLL
  • OPAL_PCI_REINIT
  • OPAL_PCI_RESET
  • OPAL_PCI_SET_P2P
  • OPAL_PCI_SET_PE
  • OPAL_PCI_SET_PELTV
  • OPAL_PCI_SET_PHB_CAPI_MODE
  • OPAL_PCI_SET_PHB_MEM_WINDOW
  • OPAL_PCI_SET_POWER_STATE
  • OPAL_PCI_SET_XIVE_PE
  • OPAL_PCI_TCE_KILL
  • OPAL_PHB_SET_OPTION
  • OPAL_PHB_GET_OPTION
  • OPAL_POLL_EVENTS
  • OPAL Power Shift Ratio
  • OPAL Power Caps
  • OPAL_PRD_MSG
  • OPAL_QUERY_CPU_STATUS
  • OPAL_QUIESCE
  • OPAL Timed Power On and Delayed Power Off
  • OPAL_REINIT_CPUS
  • OPAL_RESYNC_TIMEBASE
  • OPAL Real Time Clock (RTC) APIs
  • OPAL Secure Variable API
  • OPAL_SECVAR_GET
  • OPAL_SECVAR_GET_NEXT
  • OPAL_SECVAR_ENQUEUE_UPDATE
  • OPAL Sensor Groups
  • OPAL_SENSOR_READ
  • OPAL_SENSOR_READ_U64
  • OPAL_SET_XIVE
  • OPAL_SIGNAL_SYSTEM_RESET
  • OPAL_SLW_SET_REG
  • Starting and stopping secondary CPUs
  • OPAL_SYNC_HOST_REBOOT
  • OPAL_TEST
  • OPAL_WRITE_OPPANEL_ASYNC
  • OPAL_XSCOM_READ
  • OPAL_XSCOM_WRITE
  • OPAL_NX_COPROC_INIT
  • POWER9 Changes to OPAL API
  • OPAL API Return Codes
  • Removed Calls
  • Future Calls

skiboot Release Notes

• Release Notes
  • skiboot 4.0
  • skiboot 4.1
  • skiboot 4.1.1
  • skiboot 5.0
  • skiboot-5.1.0
  • skiboot-5.1.0-beta1
  • skiboot-5.1.0-beta2
  • skiboot-5.1.1
  • skiboot-5.1.10
  • skiboot-5.1.11
  • skiboot-5.1.12
  • skiboot-5.1.13
  • skiboot-5.1.14
  • skiboot-5.1.15
  • skiboot-5.1.16
  • skiboot-5.1.17
  • skiboot-5.1.18
  • skiboot-5.1.19
  • skiboot-5.1.2
  • skiboot-5.1.20
  • skiboot-5.1.21
  • skiboot-5.1.3
  • skiboot-5.1.4
  • skiboot-5.1.5
  • skiboot-5.1.6
  • skiboot-5.1.7
  • skiboot-5.1.8
  • skiboot-5.1.9
  • skiboot-5.10
  • skiboot-5.10-rc1
  • skiboot-5.10-rc2
  • skiboot-5.10-rc3
  • skiboot-5.10-rc4
  • skiboot-5.10.1
  • skiboot-5.10.2
  • skiboot-5.10.3
  • skiboot-5.10.4
  • skiboot-5.10.5
  • skiboot-5.10.6
  • skiboot-5.11
  • skiboot-5.11-rc1
  • skiboot-5.2.0
  • skiboot-5.2.0-rc1
  • skiboot-5.2.0-rc2
  • skiboot-5.2.1
  • skiboot-5.2.2
  • skiboot-5.2.3
  • skiboot-5.2.4
  • skiboot-5.2.5
  • skiboot-5.3.0
  • skiboot-5.3.0-rc1
  • skiboot-5.3.0-rc2
  • skiboot-5.3.1
  • skiboot-5.3.2
  • skiboot-5.3.3
  • skiboot-5.3.4
  • skiboot-5.3.5
  • skiboot-5.3.6
  • skiboot-5.3.7
  • skiboot-5.4.0
  • skiboot-5.4.0-rc1
  • skiboot-5.4.0-rc2
  • skiboot-5.4.0-rc3
  • skiboot-5.4.0-rc4
  • skiboot-5.4.1
  • skiboot-5.4.10
  • skiboot-5.4.11
  • skiboot-5.4.12
  • skiboot-5.4.2
  • skiboot-5.4.3
  • skiboot-5.4.4
  • skiboot-5.4.5
  • skiboot-5.4.6
  • skiboot-5.4.7
  • skiboot-5.4.8
  • skiboot-5.4.9
  • skiboot-5.5.0
  • skiboot-5.5.0-rc1
  • skiboot-5.5.0-rc2
  • skiboot-5.5.0-rc3
  • skiboot-5.6.0
  • skiboot-5.6.0-rc1
  • skiboot-5.6.0-rc2
  • skiboot-5.7
  • skiboot-5.7-rc1
  • skiboot-5.7-rc2
  • skiboot-5.8
  • skiboot-5.8-rc1
  • skiboot-5.9
  • skiboot-5.9-rc1
  • skiboot-5.9-rc2
  • skiboot-5.9-rc3
  • skiboot-5.9-rc4
  • skiboot-5.9-rc5
  • skiboot-5.9.1
  • skiboot-5.9.2
  • skiboot-5.9.3
  • skiboot-5.9.4
  • skiboot-5.9.5
  • skiboot-5.9.6
  • skiboot-5.9.7
  • skiboot-5.9.8
  • skiboot-5.9.9
  • skiboot-6.0
  • skiboot-6.0-rc1
  • skiboot-6.0-rc2
  • skiboot-6.0.1
  • skiboot-6.0.10
  • skiboot-6.0.11
  • skiboot-6.0.12
  • skiboot-6.0.13
  • skiboot-6.0.14
  • skiboot-6.0.15
  • skiboot-6.0.16
  • skiboot-6.0.17
  • skiboot-6.0.18
  • skiboot-6.0.19
  • skiboot-6.0.2
  • skiboot-6.0.20
  • skiboot-6.0.21
  • skiboot-6.0.22
  • skiboot-6.0.23
  • skiboot-6.0.24
  • skiboot-6.0.3
  • skiboot-6.0.4
  • skiboot-6.0.5
  • skiboot-6.0.6
  • skiboot-6.0.7
  • skiboot-6.0.8
  • skiboot-6.0.9
  • skiboot-6.1
  • skiboot-6.1-rc1
  • skiboot-6.2
  • skiboot-6.2-rc1
  • skiboot-6.2-rc2
  • skiboot-6.2.1
  • skiboot-6.2.2
  • skiboot-6.2.3
  • skiboot-6.2.4
  • skiboot-6.3
  • skiboot-6.3-rc1
  • skiboot-6.3-rc2
  • skiboot-6.3-rc3
  • skiboot-6.3.1
  • skiboot-6.3.2
  • skiboot-6.3.3
  • skiboot-6.3.4
  • skiboot-6.3.5
  • skiboot-6.4
  • skiboot-6.4-rc1
  • skiboot-6.5
  • skiboot-6.5.1
  • skiboot-6.5.2
  • skiboot-6.5.3
  • skiboot-6.5.4
  • skiboot-6.6
  • skiboot-6.6.1
  • skiboot-6.6.2
  • skiboot-6.6.3
  • skiboot-6.6.4
  • skiboot-6.6.6
  • skiboot-6.7
  • skiboot-6.7.1
  • skiboot-6.7.2
  • skiboot-6.7.3
  • skiboot-6.8
  • skiboot-6.8.1
  • skiboot-7.0
  • skiboot-7.1