Documentation/admin-guide/btmrvl.rst

   1 =============
   2 btmrvl driver
   3 =============
   4
   5 All commands are used via debugfs interface.
   6
   7 Set/get driver configurations
   8 =============================
   9
  10 Path:   /debug/btmrvl/config/
  11
  12 gpiogap=[n], hscfgcmd
  13         These commands are used to configure the host sleep parameters::
  14         bit 8:0  -- Gap
  15         bit 16:8 -- GPIO
  16
  17         where GPIO is the pin number of GPIO used to wake up the host.
  18         It could be any valid GPIO pin# (e.g. 0-7) or 0xff (SDIO interface
  19         wakeup will be used instead).
  20
  21         where Gap is the gap in milli seconds between wakeup signal and
  22         wakeup event, or 0xff for special host sleep setting.
  23
  24         Usage::
  25
  26                 # Use SDIO interface to wake up the host and set GAP to 0x80:
  27                 echo 0xff80 > /debug/btmrvl/config/gpiogap
  28                 echo 1 > /debug/btmrvl/config/hscfgcmd
  29
  30                 # Use GPIO pin #3 to wake up the host and set GAP to 0xff:
  31                 echo 0x03ff >  /debug/btmrvl/config/gpiogap
  32                 echo 1 > /debug/btmrvl/config/hscfgcmd
  33
  34 psmode=[n], pscmd
  35         These commands are used to enable/disable auto sleep mode
  36
  37         where the option is::
  38
  39                         1       -- Enable auto sleep mode
  40                         0       -- Disable auto sleep mode
  41
  42         Usage::
  43
  44                 # Enable auto sleep mode
  45                 echo 1 > /debug/btmrvl/config/psmode
  46                 echo 1 > /debug/btmrvl/config/pscmd
  47
  48                 # Disable auto sleep mode
  49                 echo 0 > /debug/btmrvl/config/psmode
  50                 echo 1 > /debug/btmrvl/config/pscmd
  51
  52
  53 hsmode=[n], hscmd
  54         These commands are used to enable host sleep or wake up firmware
  55
  56         where the option is::
  57
  58                         1       -- Enable host sleep
  59                         0       -- Wake up firmware
  60
  61         Usage::
  62
  63                 # Enable host sleep
  64                 echo 1 > /debug/btmrvl/config/hsmode
  65                 echo 1 > /debug/btmrvl/config/hscmd
  66
  67                 # Wake up firmware
  68                 echo 0 > /debug/btmrvl/config/hsmode
  69                 echo 1 > /debug/btmrvl/config/hscmd
  70
  71
  72 Get driver status
  73 =================
  74
  75 Path:   /debug/btmrvl/status/
  76
  77 Usage::
  78
  79         cat /debug/btmrvl/status/<args>
  80
  81 where the args are:
  82
  83 curpsmode
  84         This command displays current auto sleep status.
  85
  86 psstate
  87         This command display the power save state.
  88
  89 hsstate
  90         This command display the host sleep state.
  91
  92 txdnldrdy
  93         This command displays the value of Tx download ready flag.
  94
  95 Issuing a raw hci command
  96 =========================
  97
  98 Use hcitool to issue raw hci command, refer to hcitool manual
  99
 100 Usage::
 101
 102         Hcitool cmd <ogf> <ocf> [Parameters]
 103
 104 Interface Control Command::
 105
 106         hcitool cmd 0x3f 0x5b 0xf5 0x01 0x00    --Enable All interface
 107         hcitool cmd 0x3f 0x5b 0xf5 0x01 0x01    --Enable Wlan interface
 108         hcitool cmd 0x3f 0x5b 0xf5 0x01 0x02    --Enable BT interface
 109         hcitool cmd 0x3f 0x5b 0xf5 0x00 0x00    --Disable All interface
 110         hcitool cmd 0x3f 0x5b 0xf5 0x00 0x01    --Disable Wlan interface
 111         hcitool cmd 0x3f 0x5b 0xf5 0x00 0x02    --Disable BT interface
 112
 113 SD8688 firmware
 114 ===============
 115
 116 Images:
 117
 118 - /lib/firmware/sd8688_helper.bin
 119 - /lib/firmware/sd8688.bin
 120
 121
 122 The images can be downloaded from:
 123
 124 git.infradead.org/users/dwmw2/linux-firmware.git/libertas/