FreeCalypso > hg > freecalypso-tools

comparison rvinterf/asyncshell/helpfile @ 751:5dd748850f2b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
fc-shell help: batt command: better documentation The semantic meaning of the two bytes carried in the MMI_BATTERY_IND primitive depends on the firmware version. Update the documentation to describe what these two bytes mean in current FC Tourmaline firmware.
author Mychaela Falconia <falcon@freecalypso.org>
date Thu, 05 Nov 2020 19:30:14 +0000
parents fa6fee41f06e
children
comparison
equal deleted inserted replaced
750:db7b2724203b 751:5dd748850f2b
33 Any time you send anything to ATI, fc-shell automatically performs the 33 Any time you send anything to ATI, fc-shell automatically performs the
34 equivalent of an enable ati command so you can see ATI's responses; any 34 equivalent of an enable ati command so you can see ATI's responses; any
35 asynchronous output from ATI is also enabled as a side effect. 35 asynchronous output from ATI is also enabled as a side effect.
36 36
37 === batt 37 === batt
38 batt <byte1> <byte2> 38 batt <state> <level>
39 39
40 TI's MFW (UI firmware component) uses MMI_BATTERY_IND primitive (in the GPF and 40 TI's MFW (UI firmware component) uses MMI_BATTERY_IND primitive (in the GPF and
41 protocol stack sense) to communicate battery events from driver callback 41 protocol stack sense) to communicate battery events from driver callback
42 functions to the MMI task. GPF allows any protocol stack primitive to be 42 functions to the MMI task. GPF allows any protocol stack primitive to be
43 injected externally; sending this MMI_BATTERY_IND primitive from the development 43 injected externally; sending this MMI_BATTERY_IND primitive from the development
44 host allows the UI firmware's battery functions to be exercised on development 44 host allows the UI firmware's battery functions to be exercised on development
45 boards that have no battery or charging hardware. 45 boards that have no battery or charging hardware.
46 46
47 fc-shell batt command sends an MMI_BATTERY_IND protocol stack primitive with 47 fc-shell batt command sends an MMI_BATTERY_IND protocol stack primitive with
48 user-specified parameter bytes; the meaning of these parameter bytes depends on 48 user-specified parameter bytes; the meaning of these parameter bytes depends on
49 the firmware version. 49 the firmware version. In current FC Tourmaline fw the state byte communicates
50 both durable states and transient events as listed below, whereas the level byte
51 sets the battery icon level in the [0,4] range or is set to 255 to mean no
52 battery level information in this event. Valid states and events for current
53 FC Tourmaline are as follows:
54
55 batt 0 lev -- no charging activity, lev is in [0,4] range
56 batt 1 255 -- charging in progress, battery icon becomes animated
57 batt 2 4 -- charging complete, battery icon full
58 batt 3 255 -- charger plug transient event
50 59
51 === disable 60 === disable
52 === enable 61 === enable
53 {dis,en}able ati 62 {dis,en}able ati
54 {dis,en}able gpf 63 {dis,en}able gpf