1 ==================================== 1 ====================================
2 Toshiba HDD Active Protection Sensor 2 Toshiba HDD Active Protection Sensor
3 ==================================== 3 ====================================
4 4
5 Kernel driver: toshiba_haps 5 Kernel driver: toshiba_haps
6 6
7 Author: Azael Avalos <coproscefalo@gmail.com> 7 Author: Azael Avalos <coproscefalo@gmail.com>
8 8
9 9
10 .. 0. Contents 10 .. 0. Contents
11 11
12 1. Description 12 1. Description
13 2. Interface 13 2. Interface
14 3. Accelerometer axes 14 3. Accelerometer axes
15 4. Supported devices 15 4. Supported devices
16 5. Usage 16 5. Usage
17 17
18 18
19 1. Description 19 1. Description
20 -------------- 20 --------------
21 21
22 This driver provides support for the accelerom 22 This driver provides support for the accelerometer found in various Toshiba
23 laptops, being called "Toshiba HDD Protection 23 laptops, being called "Toshiba HDD Protection - Shock Sensor" officially,
24 and detects laptops automatically with this de 24 and detects laptops automatically with this device.
25 On Windows, Toshiba provided software monitors 25 On Windows, Toshiba provided software monitors this device and provides
26 automatic HDD protection (head unload) on sudd 26 automatic HDD protection (head unload) on sudden moves or harsh vibrations,
27 however, this driver only provides a notificat 27 however, this driver only provides a notification via a sysfs file to let
28 userspace tools or daemons act accordingly, as 28 userspace tools or daemons act accordingly, as well as providing a sysfs
29 file to set the desired protection level or se 29 file to set the desired protection level or sensor sensibility.
30 30
31 31
32 2. Interface 32 2. Interface
33 ------------ 33 ------------
34 34
35 This device comes with 3 methods: 35 This device comes with 3 methods:
36 36
37 ==== ====================================== 37 ==== =====================================================================
38 _STA Checks existence of the device, return 38 _STA Checks existence of the device, returning Zero if the device does not
39 exists or is not supported. 39 exists or is not supported.
40 PTLV Sets the desired protection level. 40 PTLV Sets the desired protection level.
41 RSSS Shuts down the HDD protection interfac 41 RSSS Shuts down the HDD protection interface for a few seconds,
42 then restores normal operation. 42 then restores normal operation.
43 ==== ====================================== 43 ==== =====================================================================
44 44
45 Note: 45 Note:
46 The presence of Solid State Drives (SSD) can 46 The presence of Solid State Drives (SSD) can make this driver to fail loading,
47 given the fact that such drives have no mova 47 given the fact that such drives have no movable parts, and thus, not requiring
48 any "protection" as well as failing during t 48 any "protection" as well as failing during the evaluation of the _STA method
49 found under this device. 49 found under this device.
50 50
51 51
52 3. Accelerometer axes 52 3. Accelerometer axes
53 --------------------- 53 ---------------------
54 54
55 This device does not report any axes, however, 55 This device does not report any axes, however, to query the sensor position
56 a couple HCI (Hardware Configuration Interface 56 a couple HCI (Hardware Configuration Interface) calls (0x6D and 0xA6) are
57 provided to query such information, handled by 57 provided to query such information, handled by the kernel module toshiba_acpi
58 since kernel version 3.15. 58 since kernel version 3.15.
59 59
60 60
61 4. Supported devices 61 4. Supported devices
62 -------------------- 62 --------------------
63 63
64 This driver binds itself to the ACPI device TO 64 This driver binds itself to the ACPI device TOS620A, and any Toshiba laptop
65 with this device is supported, given the fact 65 with this device is supported, given the fact that they have the presence of
66 conventional HDD and not only SSD, or a combin 66 conventional HDD and not only SSD, or a combination of both HDD and SSD.
67 67
68 68
69 5. Usage 69 5. Usage
70 -------- 70 --------
71 71
72 The sysfs files under /sys/devices/LNXSYSTM:00 72 The sysfs files under /sys/devices/LNXSYSTM:00/LNXSYBUS:00/TOS620A:00/ are:
73 73
74 ================ =========================== 74 ================ ============================================================
75 protection_level The protection_level is rea 75 protection_level The protection_level is readable and writeable, and
76 provides a way to let users 76 provides a way to let userspace query the current protection
77 level, as well as set the d 77 level, as well as set the desired protection level, the
78 available protection levels 78 available protection levels are::
79 79
80 ============ ======= 80 ============ ======= ========== ========
81 0 - Disabled 1 - Low 81 0 - Disabled 1 - Low 2 - Medium 3 - High
82 ============ ======= 82 ============ ======= ========== ========
83 83
84 reset_protection The reset_protection entry 84 reset_protection The reset_protection entry is writeable only, being "1"
85 the only parameter it accep 85 the only parameter it accepts, it is used to trigger
86 a reset of the protection i 86 a reset of the protection interface.
87 ================ =========================== 87 ================ ============================================================
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.