Linux-libre 4.10.7-gnu
[librecmc/linux-libre.git] / drivers / staging / unisys / Documentation / ABI / sysfs-platform-visorchipset
1 This file describes sysfs entries beneath /devices/platform/visorchipset.
2
3 What:           install/error
4 Date:           7/18/2014
5 KernelVersion:  TBD
6 Contact:        sparmaintainer@unisys.com
7 Description:    used to send the ID of a string that should be displayed on
8                 s-Par's automatic installation progress screen when an error
9                 is encountered during installation. This field has no effect
10                 if not in installation mode.
11 Users:          sparmaintainer@unisys.com
12
13 What:           install/remainingsteps
14 Date:           7/18/2014
15 KernelVersion:  TBD
16 Contact:        sparmaintainer@unisys.com
17 Description:    used to set the value of the progress bar on the s-Par automatic
18                 installation progress screen. This field has no effect if not in
19                 installation mode.
20 Users:          sparmaintainer@unisys.com
21
22 What:           install/textid
23 Date:           7/18/2014
24 KernelVersion:  TBD
25 Contact:        sparmaintainer@unisys.com
26 Description:    used to send the ID of a string that should be displayed on
27                 s-Par's automatic installation progress screen. Setting this
28                 field when not in installation mode (boottotool was set on
29                 the previous guest boot) has no effect.
30 Users:          sparmaintainer@unisys.com
31
32 What:           install/boottotool
33 Date:           7/18/2014
34 KernelVersion:  TBD
35 Contact:        sparmaintainer@unisys.com
36 Description:    The boottotool flag controls s-Par behavior on the next boot of
37                 this guest. Setting the flag will cause the guest to boot from
38                 the utility and installation image, which will use the value in
39                 the toolaction field to determine what operation is being
40                 requested.
41 Users:          sparmaintainer@unisys.com
42
43 What:           install/toolaction
44 Date:           7/18/2014
45 KernelVersion:  TBD
46 Contact:        sparmaintainer@unisys.com
47 Description:    This field is used to tell s-Par which type of recovery tool
48                 action to perform on the next guest boot-up. The meaning of the
49                 value is dependent on the type of installation software used to
50                 commission the guest.
51 Users:          sparmaintainer@unisys.com
52
53 What:           parahotplug/deviceenabled
54 Date:           7/18/2014
55 KernelVersion:  TBD
56 Contact:        sparmaintainer@unisys.com
57 Description:    This entry is used by a Unisys support script installed on the
58                 guest, and triggered by a udev event. The support script is
59                 responsible for enabling and disabling SR-IOV devices when the
60                 PF device is being recovered in another guest.
61
62                 Some SR-IOV devices have problems when the PF is reset without
63                 first disabling all VFs attached to that PF. s-Par handles this
64                 situation by sending a message to guests using these VFs, and
65                 the script will disable the device. When the PF is recovered,
66                 another message is sent to the guests to re-enable the VFs.
67
68                 The parahotplug/deviceenabled interface is used to acknowledge
69                 the recovery message.
70 Users:          sparmaintainer@unisys.com
71
72 What:           parahotplug/devicedisabled
73 Date:           7/18/2014
74 KernelVersion:  TBD
75 Contact:        sparmaintainer@unisys.com
76 Description:    This entry is used by a Unisys support script installed on the
77                 guest, and triggered by a udev event. The support script is
78                 responsible for enabling and disabling SR-IOV devices when the
79                 PF device is being recovered in another guest.
80
81                 Some SR-IOV devices have problems when the PF is reset without
82                 first disabling all VFs attached to that PF. s-Par handles this
83                 situation by sending a message to guests using these VFs, and
84                 the script will disable the device. When the PF is recovered,
85                 another message is sent to the guests to re-enable the VFs.
86
87                 The parahotplug/devicedisaabled interface is used to acknowledge
88                 the initial recovery message.
89 Users:          sparmaintainer@unisys.com