Commit 7f4e0121 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Jonathan Corbet

btmrvl.txt: standardize document format

Each text file under Documentation follows a different
format. Some doesn't even have titles!

Change its representation to follow the adopted standard,
using ReST markups for it to be parseable by Sphinx:

- Use the right notation for titles;
- Use a list for image names;
- Use literal blocks where needed;
- Whitespace fixes.
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent b4b8af5c
======================================================================= =============
README for btmrvl driver btmrvl driver
======================================================================= =============
All commands are used via debugfs interface. All commands are used via debugfs interface.
===================== Set/get driver configurations
Set/get driver configurations: =============================
Path: /debug/btmrvl/config/ Path: /debug/btmrvl/config/
gpiogap=[n] gpiogap=[n], hscfgcmd
hscfgcmd These commands are used to configure the host sleep parameters::
These commands are used to configure the host sleep parameters.
bit 8:0 -- Gap bit 8:0 -- Gap
bit 16:8 -- GPIO bit 16:8 -- GPIO
...@@ -23,7 +21,8 @@ hscfgcmd ...@@ -23,7 +21,8 @@ hscfgcmd
where Gap is the gap in milli seconds between wakeup signal and where Gap is the gap in milli seconds between wakeup signal and
wakeup event, or 0xff for special host sleep setting. wakeup event, or 0xff for special host sleep setting.
Usage: Usage::
# Use SDIO interface to wake up the host and set GAP to 0x80: # Use SDIO interface to wake up the host and set GAP to 0x80:
echo 0xff80 > /debug/btmrvl/config/gpiogap echo 0xff80 > /debug/btmrvl/config/gpiogap
echo 1 > /debug/btmrvl/config/hscfgcmd echo 1 > /debug/btmrvl/config/hscfgcmd
...@@ -32,15 +31,16 @@ hscfgcmd ...@@ -32,15 +31,16 @@ hscfgcmd
echo 0x03ff > /debug/btmrvl/config/gpiogap echo 0x03ff > /debug/btmrvl/config/gpiogap
echo 1 > /debug/btmrvl/config/hscfgcmd echo 1 > /debug/btmrvl/config/hscfgcmd
psmode=[n] psmode=[n], pscmd
pscmd
These commands are used to enable/disable auto sleep mode These commands are used to enable/disable auto sleep mode
where the option is: where the option is::
1 -- Enable auto sleep mode 1 -- Enable auto sleep mode
0 -- Disable auto sleep mode 0 -- Disable auto sleep mode
Usage: Usage::
# Enable auto sleep mode # Enable auto sleep mode
echo 1 > /debug/btmrvl/config/psmode echo 1 > /debug/btmrvl/config/psmode
echo 1 > /debug/btmrvl/config/pscmd echo 1 > /debug/btmrvl/config/pscmd
...@@ -50,15 +50,16 @@ pscmd ...@@ -50,15 +50,16 @@ pscmd
echo 1 > /debug/btmrvl/config/pscmd echo 1 > /debug/btmrvl/config/pscmd
hsmode=[n] hsmode=[n], hscmd
hscmd
These commands are used to enable host sleep or wake up firmware These commands are used to enable host sleep or wake up firmware
where the option is: where the option is::
1 -- Enable host sleep 1 -- Enable host sleep
0 -- Wake up firmware 0 -- Wake up firmware
Usage: Usage::
# Enable host sleep # Enable host sleep
echo 1 > /debug/btmrvl/config/hsmode echo 1 > /debug/btmrvl/config/hsmode
echo 1 > /debug/btmrvl/config/hscmd echo 1 > /debug/btmrvl/config/hscmd
...@@ -68,12 +69,13 @@ hscmd ...@@ -68,12 +69,13 @@ hscmd
echo 1 > /debug/btmrvl/config/hscmd echo 1 > /debug/btmrvl/config/hscmd
====================== Get driver status
Get driver status: =================
Path: /debug/btmrvl/status/ Path: /debug/btmrvl/status/
Usage: Usage::
cat /debug/btmrvl/status/<args> cat /debug/btmrvl/status/<args>
where the args are: where the args are:
...@@ -90,14 +92,17 @@ hsstate ...@@ -90,14 +92,17 @@ hsstate
txdnldrdy txdnldrdy
This command displays the value of Tx download ready flag. This command displays the value of Tx download ready flag.
Issuing a raw hci command
===================== =========================
Use hcitool to issue raw hci command, refer to hcitool manual Use hcitool to issue raw hci command, refer to hcitool manual
Usage: Hcitool cmd <ogf> <ocf> [Parameters] Usage::
Hcitool cmd <ogf> <ocf> [Parameters]
Interface Control Command::
Interface Control Command
hcitool cmd 0x3f 0x5b 0xf5 0x01 0x00 --Enable All interface hcitool cmd 0x3f 0x5b 0xf5 0x01 0x00 --Enable All interface
hcitool cmd 0x3f 0x5b 0xf5 0x01 0x01 --Enable Wlan interface hcitool cmd 0x3f 0x5b 0xf5 0x01 0x01 --Enable Wlan interface
hcitool cmd 0x3f 0x5b 0xf5 0x01 0x02 --Enable BT interface hcitool cmd 0x3f 0x5b 0xf5 0x01 0x02 --Enable BT interface
...@@ -105,13 +110,13 @@ Use hcitool to issue raw hci command, refer to hcitool manual ...@@ -105,13 +110,13 @@ Use hcitool to issue raw hci command, refer to hcitool manual
hcitool cmd 0x3f 0x5b 0xf5 0x00 0x01 --Disable Wlan interface hcitool cmd 0x3f 0x5b 0xf5 0x00 0x01 --Disable Wlan interface
hcitool cmd 0x3f 0x5b 0xf5 0x00 0x02 --Disable BT interface hcitool cmd 0x3f 0x5b 0xf5 0x00 0x02 --Disable BT interface
======================================================================= SD8688 firmware
===============
SD8688 firmware: Images:
/lib/firmware/sd8688_helper.bin - /lib/firmware/sd8688_helper.bin
/lib/firmware/sd8688.bin - /lib/firmware/sd8688.bin
The images can be downloaded from: The images can be downloaded from:
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment