diff options
Diffstat (limited to 'Documentation')
-rw-r--r-- | Documentation/ABI/testing/sysfs-block-rssd | 12 | ||||
-rw-r--r-- | Documentation/ABI/testing/sysfs-bus-fcoe | 77 | ||||
-rw-r--r-- | Documentation/feature-removal-schedule.txt | 6 | ||||
-rw-r--r-- | Documentation/power/charger-manager.txt | 41 | ||||
-rw-r--r-- | Documentation/power/power_supply_class.txt | 2 |
5 files changed, 134 insertions, 4 deletions
diff --git a/Documentation/ABI/testing/sysfs-block-rssd b/Documentation/ABI/testing/sysfs-block-rssd index d535757799fe..679ce3543122 100644 --- a/Documentation/ABI/testing/sysfs-block-rssd +++ b/Documentation/ABI/testing/sysfs-block-rssd | |||
@@ -6,13 +6,21 @@ Description: This is a read-only file. Dumps below driver information and | |||
6 | hardware registers. | 6 | hardware registers. |
7 | - S ACTive | 7 | - S ACTive |
8 | - Command Issue | 8 | - Command Issue |
9 | - Allocated | ||
10 | - Completed | 9 | - Completed |
11 | - PORT IRQ STAT | 10 | - PORT IRQ STAT |
12 | - HOST IRQ STAT | 11 | - HOST IRQ STAT |
12 | - Allocated | ||
13 | - Commands in Q | ||
13 | 14 | ||
14 | What: /sys/block/rssd*/status | 15 | What: /sys/block/rssd*/status |
15 | Date: April 2012 | 16 | Date: April 2012 |
16 | KernelVersion: 3.4 | 17 | KernelVersion: 3.4 |
17 | Contact: Asai Thambi S P <asamymuthupa@micron.com> | 18 | Contact: Asai Thambi S P <asamymuthupa@micron.com> |
18 | Description: This is a read-only file. Indicates the status of the device. | 19 | Description: This is a read-only file. Indicates the status of the device. |
20 | |||
21 | What: /sys/block/rssd*/flags | ||
22 | Date: May 2012 | ||
23 | KernelVersion: 3.5 | ||
24 | Contact: Asai Thambi S P <asamymuthupa@micron.com> | ||
25 | Description: This is a read-only file. Dumps the flags in port and driver | ||
26 | data structure | ||
diff --git a/Documentation/ABI/testing/sysfs-bus-fcoe b/Documentation/ABI/testing/sysfs-bus-fcoe new file mode 100644 index 000000000000..469d09c02f6b --- /dev/null +++ b/Documentation/ABI/testing/sysfs-bus-fcoe | |||
@@ -0,0 +1,77 @@ | |||
1 | What: /sys/bus/fcoe/ctlr_X | ||
2 | Date: March 2012 | ||
3 | KernelVersion: TBD | ||
4 | Contact: Robert Love <robert.w.love@intel.com>, devel@open-fcoe.org | ||
5 | Description: 'FCoE Controller' instances on the fcoe bus | ||
6 | Attributes: | ||
7 | |||
8 | fcf_dev_loss_tmo: Device loss timeout peroid (see below). Changing | ||
9 | this value will change the dev_loss_tmo for all | ||
10 | FCFs discovered by this controller. | ||
11 | |||
12 | lesb_link_fail: Link Error Status Block (LESB) link failure count. | ||
13 | |||
14 | lesb_vlink_fail: Link Error Status Block (LESB) virtual link | ||
15 | failure count. | ||
16 | |||
17 | lesb_miss_fka: Link Error Status Block (LESB) missed FCoE | ||
18 | Initialization Protocol (FIP) Keep-Alives (FKA). | ||
19 | |||
20 | lesb_symb_err: Link Error Status Block (LESB) symbolic error count. | ||
21 | |||
22 | lesb_err_block: Link Error Status Block (LESB) block error count. | ||
23 | |||
24 | lesb_fcs_error: Link Error Status Block (LESB) Fibre Channel | ||
25 | Serivces error count. | ||
26 | |||
27 | Notes: ctlr_X (global increment starting at 0) | ||
28 | |||
29 | What: /sys/bus/fcoe/fcf_X | ||
30 | Date: March 2012 | ||
31 | KernelVersion: TBD | ||
32 | Contact: Robert Love <robert.w.love@intel.com>, devel@open-fcoe.org | ||
33 | Description: 'FCoE FCF' instances on the fcoe bus. A FCF is a Fibre Channel | ||
34 | Forwarder, which is a FCoE switch that can accept FCoE | ||
35 | (Ethernet) packets, unpack them, and forward the embedded | ||
36 | Fibre Channel frames into a FC fabric. It can also take | ||
37 | outbound FC frames and pack them in Ethernet packets to | ||
38 | be sent to their destination on the Ethernet segment. | ||
39 | Attributes: | ||
40 | |||
41 | fabric_name: Identifies the fabric that the FCF services. | ||
42 | |||
43 | switch_name: Identifies the FCF. | ||
44 | |||
45 | priority: The switch's priority amongst other FCFs on the same | ||
46 | fabric. | ||
47 | |||
48 | selected: 1 indicates that the switch has been selected for use; | ||
49 | 0 indicates that the swich will not be used. | ||
50 | |||
51 | fc_map: The Fibre Channel MAP | ||
52 | |||
53 | vfid: The Virtual Fabric ID | ||
54 | |||
55 | mac: The FCF's MAC address | ||
56 | |||
57 | fka_peroid: The FIP Keep-Alive peroid | ||
58 | |||
59 | fabric_state: The internal kernel state | ||
60 | "Unknown" - Initialization value | ||
61 | "Disconnected" - No link to the FCF/fabric | ||
62 | "Connected" - Host is connected to the FCF | ||
63 | "Deleted" - FCF is being removed from the system | ||
64 | |||
65 | dev_loss_tmo: The device loss timeout peroid for this FCF. | ||
66 | |||
67 | Notes: A device loss infrastructre similar to the FC Transport's | ||
68 | is present in fcoe_sysfs. It is nice to have so that a | ||
69 | link flapping adapter doesn't continually advance the count | ||
70 | used to identify the discovered FCF. FCFs will exist in a | ||
71 | "Disconnected" state until either the timer expires and the | ||
72 | FCF becomes "Deleted" or the FCF is rediscovered and becomes | ||
73 | "Connected." | ||
74 | |||
75 | |||
76 | Users: The first user of this interface will be the fcoeadm application, | ||
77 | which is commonly packaged in the fcoe-utils package. | ||
diff --git a/Documentation/feature-removal-schedule.txt b/Documentation/feature-removal-schedule.txt index ebaffe208ccb..56000b33340b 100644 --- a/Documentation/feature-removal-schedule.txt +++ b/Documentation/feature-removal-schedule.txt | |||
@@ -606,3 +606,9 @@ Why: There are two mci drivers: at91-mci and atmel-mci. The PDC support | |||
606 | Who: Ludovic Desroches <ludovic.desroches@atmel.com> | 606 | Who: Ludovic Desroches <ludovic.desroches@atmel.com> |
607 | 607 | ||
608 | ---------------------------- | 608 | ---------------------------- |
609 | |||
610 | What: net/wanrouter/ | ||
611 | When: June 2013 | ||
612 | Why: Unsupported/unmaintained/unused since 2.6 | ||
613 | |||
614 | ---------------------------- | ||
diff --git a/Documentation/power/charger-manager.txt b/Documentation/power/charger-manager.txt index fdcca991df30..b4f7f4b23f64 100644 --- a/Documentation/power/charger-manager.txt +++ b/Documentation/power/charger-manager.txt | |||
@@ -44,6 +44,16 @@ Charger Manager supports the following: | |||
44 | Normally, the platform will need to resume and suspend some devices | 44 | Normally, the platform will need to resume and suspend some devices |
45 | that are used by Charger Manager. | 45 | that are used by Charger Manager. |
46 | 46 | ||
47 | * Support for premature full-battery event handling | ||
48 | If the battery voltage drops by "fullbatt_vchkdrop_uV" after | ||
49 | "fullbatt_vchkdrop_ms" from the full-battery event, the framework | ||
50 | restarts charging. This check is also performed while suspended by | ||
51 | setting wakeup time accordingly and using suspend_again. | ||
52 | |||
53 | * Support for uevent-notify | ||
54 | With the charger-related events, the device sends | ||
55 | notification to users with UEVENT. | ||
56 | |||
47 | 2. Global Charger-Manager Data related with suspend_again | 57 | 2. Global Charger-Manager Data related with suspend_again |
48 | ======================================================== | 58 | ======================================================== |
49 | In order to setup Charger Manager with suspend-again feature | 59 | In order to setup Charger Manager with suspend-again feature |
@@ -55,7 +65,7 @@ if there are multiple batteries. If there are multiple batteries, the | |||
55 | multiple instances of Charger Manager share the same charger_global_desc | 65 | multiple instances of Charger Manager share the same charger_global_desc |
56 | and it will manage in-suspend monitoring for all instances of Charger Manager. | 66 | and it will manage in-suspend monitoring for all instances of Charger Manager. |
57 | 67 | ||
58 | The user needs to provide all the two entries properly in order to activate | 68 | The user needs to provide all the three entries properly in order to activate |
59 | in-suspend monitoring: | 69 | in-suspend monitoring: |
60 | 70 | ||
61 | struct charger_global_desc { | 71 | struct charger_global_desc { |
@@ -74,6 +84,11 @@ bool (*rtc_only_wakeup)(void); | |||
74 | same struct. If there is any other wakeup source triggered the | 84 | same struct. If there is any other wakeup source triggered the |
75 | wakeup, it should return false. If the "rtc" is the only wakeup | 85 | wakeup, it should return false. If the "rtc" is the only wakeup |
76 | reason, it should return true. | 86 | reason, it should return true. |
87 | |||
88 | bool assume_timer_stops_in_suspend; | ||
89 | : if true, Charger Manager assumes that | ||
90 | the timer (CM uses jiffies as timer) stops during suspend. Then, CM | ||
91 | assumes that the suspend-duration is same as the alarm length. | ||
77 | }; | 92 | }; |
78 | 93 | ||
79 | 3. How to setup suspend_again | 94 | 3. How to setup suspend_again |
@@ -111,6 +126,16 @@ enum polling_modes polling_mode; | |||
111 | CM_POLL_CHARGING_ONLY: poll this battery if and only if the | 126 | CM_POLL_CHARGING_ONLY: poll this battery if and only if the |
112 | battery is being charged. | 127 | battery is being charged. |
113 | 128 | ||
129 | unsigned int fullbatt_vchkdrop_ms; | ||
130 | unsigned int fullbatt_vchkdrop_uV; | ||
131 | : If both have non-zero values, Charger Manager will check the | ||
132 | battery voltage drop fullbatt_vchkdrop_ms after the battery is fully | ||
133 | charged. If the voltage drop is over fullbatt_vchkdrop_uV, Charger | ||
134 | Manager will try to recharge the battery by disabling and enabling | ||
135 | chargers. Recharge with voltage drop condition only (without delay | ||
136 | condition) is needed to be implemented with hardware interrupts from | ||
137 | fuel gauges or charger devices/chips. | ||
138 | |||
114 | unsigned int fullbatt_uV; | 139 | unsigned int fullbatt_uV; |
115 | : If specified with a non-zero value, Charger Manager assumes | 140 | : If specified with a non-zero value, Charger Manager assumes |
116 | that the battery is full (capacity = 100) if the battery is not being | 141 | that the battery is full (capacity = 100) if the battery is not being |
@@ -122,6 +147,8 @@ unsigned int polling_interval_ms; | |||
122 | this battery every polling_interval_ms or more frequently. | 147 | this battery every polling_interval_ms or more frequently. |
123 | 148 | ||
124 | enum data_source battery_present; | 149 | enum data_source battery_present; |
150 | : CM_BATTERY_PRESENT: assume that the battery exists. | ||
151 | CM_NO_BATTERY: assume that the battery does not exists. | ||
125 | CM_FUEL_GAUGE: get battery presence information from fuel gauge. | 152 | CM_FUEL_GAUGE: get battery presence information from fuel gauge. |
126 | CM_CHARGER_STAT: get battery presence from chargers. | 153 | CM_CHARGER_STAT: get battery presence from chargers. |
127 | 154 | ||
@@ -151,7 +178,17 @@ bool measure_battery_temp; | |||
151 | the value of measure_battery_temp. | 178 | the value of measure_battery_temp. |
152 | }; | 179 | }; |
153 | 180 | ||
154 | 5. Other Considerations | 181 | 5. Notify Charger-Manager of charger events: cm_notify_event() |
182 | ========================================================= | ||
183 | If there is an charger event is required to notify | ||
184 | Charger Manager, a charger device driver that triggers the event can call | ||
185 | cm_notify_event(psy, type, msg) to notify the corresponding Charger Manager. | ||
186 | In the function, psy is the charger driver's power_supply pointer, which is | ||
187 | associated with Charger-Manager. The parameter "type" | ||
188 | is the same as irq's type (enum cm_event_types). The event message "msg" is | ||
189 | optional and is effective only if the event type is "UNDESCRIBED" or "OTHERS". | ||
190 | |||
191 | 6. Other Considerations | ||
155 | ======================= | 192 | ======================= |
156 | 193 | ||
157 | At the charger/battery-related events such as battery-pulled-out, | 194 | At the charger/battery-related events such as battery-pulled-out, |
diff --git a/Documentation/power/power_supply_class.txt b/Documentation/power/power_supply_class.txt index 9f16c5178b66..211831d4095f 100644 --- a/Documentation/power/power_supply_class.txt +++ b/Documentation/power/power_supply_class.txt | |||
@@ -84,6 +84,8 @@ are already charged or discharging, 'n/a' can be displayed (or | |||
84 | HEALTH - represents health of the battery, values corresponds to | 84 | HEALTH - represents health of the battery, values corresponds to |
85 | POWER_SUPPLY_HEALTH_*, defined in battery.h. | 85 | POWER_SUPPLY_HEALTH_*, defined in battery.h. |
86 | 86 | ||
87 | VOLTAGE_OCV - open circuit voltage of the battery. | ||
88 | |||
87 | VOLTAGE_MAX_DESIGN, VOLTAGE_MIN_DESIGN - design values for maximal and | 89 | VOLTAGE_MAX_DESIGN, VOLTAGE_MIN_DESIGN - design values for maximal and |
88 | minimal power supply voltages. Maximal/minimal means values of voltages | 90 | minimal power supply voltages. Maximal/minimal means values of voltages |
89 | when battery considered "full"/"empty" at normal conditions. Yes, there is | 91 | when battery considered "full"/"empty" at normal conditions. Yes, there is |