###############################################################################
# Helper script: /load_kernel_modules.scr/platform/aarch64/sc8280xp
# Purpose......: Set the Kernel modules for the Snapdragon sc8280xp SoC
#                Hardware Models, within the Slackware initial RAM disk
#                ('OS initrd') and the Slackware installer.
#                This script is sourced from '/load_kernel_modules'
#
# Important Note:
# * You must _append_ to the module lists (as this script does)
#   otherwise the base set of modules will not be loaded and would result in
#   a Kernel panic.
# * The initrd uses the 'bash' shell, rather than 'busybox'
#   (as in upstream/x86 Slackware). This allows you (for example)
#   to use 'fallthrough' (case statements terminated with ';&'
#   rather than ';;') within case statements and regular expression
#   matches within 'if' statements.
#   This permits the 'c'-style switch statements where you can
#   'inherit' the previous matches as you move down the cases.
#   This enables you to match on varients of boards, and inherit
#   a 'baseline' of platform modules for that board.
#
# The 'PLATWALK' match is to enable build scripts to process these
# scripts outside of the initrd environment and determine which
# modules will be loaded by a particular Hardware Model.  This must remain
# in place for all scripts.
###############################################################################

# As an example, $HWM might contain the string:
# "Lenovo ThinkPad X13s"
#
# Listed on: https://wiki.gentoo.org/wiki/Lenovo_ThinkPad_X13s 
# nvme phy_qcom_qmp_pcie pcie_qcom i2c_hid_of i2c_qcom_geni leds_qcom_lpg
# pwm_bl qrtr pmic_glink_altmode gpio_sbu_mux phy_qcom_qmp_combo panel-edp msm phy_qcom_edp
case $HWM in
   "Lenovo ThinkPad X13s"*|PLATWALK)
      platform_detected=1
      SOC_NAME=sc8280xp
      # Set the short name that is used by /load_kernel_modules to install
      # the appropriate configuration for modprobe for this Hardware Model:
      # These files are stored within the source tree:
      # source/k/SlkOS-initrd-overlay/usr/share/hwm-configure/platform/aarch64/modprobe.d/
      #
      # Note: Typically these are only used to blacklist particular modules from loading
      # within the OS InitRD or Installer.  Within the OS the regular location of
      # /lib/modprobe.d/ is used and has no connection to the content of the
      # OS InitRD/Installer.
      HWM_SHORTNAME=thinkpad-x13s

      echo "Architecture: ${ARCH}, Hardware model: ${HWM}, SoC: ${SOC_NAME}"
      # If one of the modules within the base list is causing problems on
      # your platform, here are the options laid out as examples:
      # USB="${USB/ehci_orion/differentmodule}" # Substitute module 'ehci_orion' with 'differentmodule'
      # USB="${USB/ehci_orion/}" # Remove the 'ehci_orion' module from the list
      MOD_GPIO+="   gpio_sbu_mux"
      # Drivers for PCI and other core sub systems:
      MOD_PHY+="    pcie_qcom phy_qcom_qmp_pcie phy_qcom_gmp_combo"
      # Video/display drivers:
      MOD_VIDEO+="  panel-edp msm phy_qcom_edp pmic_glink_altmode"
      # MFD (Multi Functional Devices) drivers:
      MOD_MFD+="    leds_qcom_lpg pwm_bl qrtr"
      # For SDHC/MMC storage:
      MOD_CARDS+="  nvme"
      # Drivers for USB hardware for this particular Hardware Model:
      MOD_USB+="    "
      # Ethernet network driver:
      MOD_NET+="    "
      # TODO: Consider adding wifi support for this device to ease the installation
      # process for users without an ethernet adapter for usb-c?
      # - There isn't a serial port to use
      # MOD_WIFI+="   ath11k_pci" 
      # Any modules related to compression/decompression and cryptography
      MOD_CMP+="    "
      MOD_CRYPTO+=" "
      # The following modules do not inherit from the parent loader '/load_kernel_modules'
      #MOD_RTC="rtc_XYZ"
      # Modules for the peripherals on the Hardware Model's main board
      # (outside of the SoC itself)
      MOD_HWM=""
      # Modules for the IP blocks/peripherals embedded within the SoC:
      MOD_SOC="i2c_hid_of i2c_qcom_geni"

      # Detect a specfic AMD graphics card and load the Kernel module:
      # This couldn't be detected during the initial Hardware Model detection because
      # the modules to light up the PCI interface were not loaded.
      #function hwm_hook_post-modload() {
        #  { lspci 2>/dev/null | grep -q 'AMDblah' ;} && modprobe amdgpu
      #;}

      # Define a function to run from the OS InitRD's '/init' immediately prior
      # to switching into the Slackware OS proper.
      # This is after any software RAID arrays et al have been initialised.
      #
      # At this stage, the following paths for Slackware OS are mounted:
      # /proc, /sys, /run, /dev
      # The root file system ('/') is mounted under /mnt
      #
      #function hwm_hook_pre_switch_root() {
      #  echo "Just about to switch into the Slackware OS proper, leaving the OS InitRD"
      #}
      ;;
esac

# The '/load_kernel_modules' script will load the modules
# set above.