Skip to content

Commit

Permalink
doc: ABI: bone_capemgr sysfs API
Browse files Browse the repository at this point in the history
Document the beaglebone's capemgr sysfs API

Signed-off-by: Pantelis Antoniou <pantelis.antoniou@konsulko.com>
  • Loading branch information
pantoniou authored and RobertCNelson committed Oct 20, 2018
1 parent 055c3ed commit 6cbca78
Showing 1 changed file with 63 additions and 0 deletions.
63 changes: 63 additions & 0 deletions Documentation/ABI/testing/sysfs-devices-platform-bone_capemgr
@@ -0,0 +1,63 @@
What: /sys/devices/platform/bone_capemgr/slots
Date: May 2015
KernelVersion: 4.0
Contact: Pantelis Antoniou <pantelis.antoniou@konsulko.com>
Description:
READ:
Describe the state of all the slots of the beaglebone capemgr.
Each line of the output describes a slot:
The slot format is as following:
<slot-id>: [P-][F-][O-][l-][L-][D-] \
<overlay-id> <board-name>,<version>,
<manufacturer>,<part-number>

Where the flags are:
P: Slot has been probed
F: Slot has failed probing (i.e. no EEPROM detected)
O: Slot has been overridden by the user
l: Slot is current loading
L: Slot has completed loading and is ready
D: Slot has been disabled

Example:
0: P---L- -1 BeagleBone RS232 CAPE,00A1,Beagleboardtoys,BB-BONE-SERL-03
1: PF---- -1
2: PF---- -1
3: PF---- -1

WRITE:
Writing a string of the form <part-number>[:version] issues a request to
load a firmware blob containing an overlay. The name of the firmware blob
is <part-number>-[version|00A0].dtbo. This act is defined as a slot override.

Writing a negative slot id removes the slot if it was an overridden one, or
unloads a slot that was probed.

What: /sys/devices/platform/bone_capemgr/baseboard/<eeprom-field>
Date: May 2015
KernelVersion: 4.0
Contact: Pantelis Antoniou <pantelis.antoniou@konsulko.com>
Description: Contains the probed base board EEPROM field; one of:
board-name - board-name as stored in cape EEPROM
dc-supplied - whether the cape draws or supplies DC
eeprom-format-revision - EEPROM format rev, only 00A0 supported
header - header; should be 'aa 55 33 ee'
manufacturer - manufacturer string
part-number - part-number of the cape
serial-number - serial number of the cape
version - version of the cape, i.e. 00A0
number-of-pins - displayed but ignored
pin-usage - displayed but ignored
sys-5v - displayed but ignored
vdd-3v3exp - displayed but ignored
vdd-5v - displayed but ignored
What: /sys/devices/platform/bone_capemgr/slot-<n>/<eeprom-field>
Date: May 2015
KernelVersion: 4.0
Contact: Pantelis Antoniou <pantelis.antoniou@konsulko.com>
Description: Contains the probed cape's EEPROM field; the field is one of:
board-name - baseboard name i.e. A335BNLT
header - header; should be 'aa 55 33 ee'
revision - baseboard revision
serial-number - baseboard serial number
config-option - displayed but ignored

0 comments on commit 6cbca78

Please sign in to comment.