lkml.org 
[lkml]   [2010]   [Feb]   [20]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    From
    Subject[PATCH 1/2] Document the rfkill sysfs ABI
    Date
    This moves sysfs ABI info from Documentation/rfkill.txt to the
    ABI subfolder and reformats it.

    Signed-off-by: Florian Mickler <florian@mickler.org>
    ---
    Documentation/ABI/stable/sysfs-class-rfkill | 64 +++++++++++++++++++++++++++
    Documentation/rfkill.txt | 44 +++++-------------
    2 files changed, 77 insertions(+), 31 deletions(-)
    create mode 100644 Documentation/ABI/stable/sysfs-class-rfkill

    diff --git a/Documentation/ABI/stable/sysfs-class-rfkill b/Documentation/ABI/stable/sysfs-class-rfkill
    new file mode 100644
    index 0000000..53a4287
    --- /dev/null
    +++ b/Documentation/ABI/stable/sysfs-class-rfkill
    @@ -0,0 +1,64 @@
    +rfkill - radio frequency (RF) connector kill switch support
    +
    +For details to this subsystem look at Documentation/rfkill.txt.
    +
    +What: /sys/class/rfkill
    +Date: 09-Jul-2007
    +KernelVersion: v2.6.22
    +Contact: linux-wireless@vger.kernel.org,
    +Description: The rfkill class subsystem folder.
    + Each registered rfkill driver is represented by an rfkillX
    + subfolder (X being an integer > 0).
    +
    +
    +What: /sys/class/rfkill/rfkill[0-9]+/name
    +Date: 09-Jul-2007
    +KernelVersion v2.6.22
    +Contact: linux-wireless@vger.kernel.org
    +Description: Name assigned by driver to this key (interface or driver name).
    +Values: arbitrary string.
    +
    +
    +What: /sys/class/rfkill/rfkill[0-9]+/type
    +Date: 09-Jul-2007
    +KernelVersion v2.6.22
    +Contact: linux-wireless@vger.kernel.org
    +Description: Driver type string ("wlan", "bluetooth", etc).
    +Values: See include/linux/rfkill.h.
    +
    +
    +What: /sys/class/rfkill/rfkill[0-9]+/persistent
    +Date: 09-Jul-2007
    +KernelVersion v2.6.22
    +Contact: linux-wireless@vger.kernel.org
    +Description: Whether the soft blocked state is initialised from non-volatile
    + storage at startup.
    +Values: A numeric value.
    + 0: false
    + 1: true
    +
    +
    +What: /sys/class/rfkill/rfkill[0-9]+/state
    +Date: 09-Jul-2007
    +KernelVersion v2.6.22
    +Contact: linux-wireless@vger.kernel.org
    +Description: Current state of the transmitter. This file is deprecated
    + because it can only properly show three of the four possible
    + states, soft-and-hard-blocked is missing.
    +Values: A numeric value.
    + 0: RFKILL_STATE_SOFT_BLOCKED
    + transmitter is turned off by software
    + 1: RFKILL_STATE_UNBLOCKED
    + transmitter is (potentially) active
    + 2: RFKILL_STATE_HARD_BLOCKED
    + transmitter is forced off by something outside of
    + the driver's control.
    +
    +
    +What: /sys/class/rfkill/rfkill[0-9]+/claim
    +Date: 09-Jul-2007
    +KernelVersion v2.6.22
    +Contact: linux-wireless@vger.kernel.org
    +Description: This file is deprecated because there no longer is a way to
    + claim just control over a single rfkill instance.
    +Values: 0: Kernel handles events
    diff --git a/Documentation/rfkill.txt b/Documentation/rfkill.txt
    index b486050..83668e5 100644
    --- a/Documentation/rfkill.txt
    +++ b/Documentation/rfkill.txt
    @@ -99,37 +99,15 @@ system. Also, it is possible to switch all rfkill drivers (or all drivers of
    a specified type) into a state which also updates the default state for
    hotplugged devices.

    -After an application opens /dev/rfkill, it can read the current state of
    -all devices, and afterwards can poll the descriptor for hotplug or state
    -change events.
    -
    -Applications must ignore operations (the "op" field) they do not handle,
    -this allows the API to be extended in the future.
    -
    -Additionally, each rfkill device is registered in sysfs and there has the
    -following attributes:
    -
    - name: Name assigned by driver to this key (interface or driver name).
    - type: Driver type string ("wlan", "bluetooth", etc).
    - persistent: Whether the soft blocked state is initialised from
    - non-volatile storage at startup.
    - state: Current state of the transmitter
    - 0: RFKILL_STATE_SOFT_BLOCKED
    - transmitter is turned off by software
    - 1: RFKILL_STATE_UNBLOCKED
    - transmitter is (potentially) active
    - 2: RFKILL_STATE_HARD_BLOCKED
    - transmitter is forced off by something outside of
    - the driver's control.
    - This file is deprecated because it can only properly show
    - three of the four possible states, soft-and-hard-blocked is
    - missing.
    - claim: 0: Kernel handles events
    - This file is deprecated because there no longer is a way to
    - claim just control over a single rfkill instance.
    -
    -rfkill devices also issue uevents (with an action of "change"), with the
    -following environment variables set:
    +After an application opens /dev/rfkill, it can read the current state of all
    +devices. Changes can be either obtained by either polling the descriptor for
    +hotplug or state change events or by listening for uevents emitted by the
    +rfkill core framework.
    +
    +Additionally, each rfkill device is registered in sysfs and emits uevents.
    +
    +rfkill devices issue uevents (with an action of "change"), with the following
    +environment variables set:

    RFKILL_NAME
    RFKILL_STATE
    @@ -137,3 +115,7 @@ RFKILL_TYPE

    The contents of these variables corresponds to the "name", "state" and
    "type" sysfs files explained above.
    +
    +
    +For further details consult Documentation/ABI/stable/dev-rfkill and
    +Documentation/ABI/stable/sysfs-class-rfkill.
    --
    1.6.6.1


    \
     
     \ /
      Last update: 2010-02-20 22:45    [W:0.027 / U:30.700 seconds]
    ©2003-2016 Jasper Spaans. hosted at Digital OceanAdvertise on this site