toshiba_acpi: Support new keyboard backlight type
Subsystems (2)
Azael Avalos
maintainerPATCH v2 4/5 toshiba_acpi: Support new keyboard backlight type
Newer Toshiba models now come with a new (and different) keyboard backlight implementation with three modes of operation: TIMER, ON and OFF, and the LED is controlled internally by the firmware.
This patch adds support for that type of backlight, changing the existing code to accomodate the new implementation.
The timeout value range is now 1-60 seconds, and the accepted modes are now: 1 (FN-Z), 2 (AUTO or TIMER), 8(ON) and 10 (OFF), this adds two new entries keyboard_type and available_kbd_modes, the first shows the keyboard type and the latter shows the supported modes depending on the type.
--- drivers/platform/x86/toshiba_acpi.c | 117 +++++++++++++++++++++++++++++++----- 1 file changed, 102 insertions(+), 15 deletions(-)
drivers/platform/x86/toshiba_acpi.c +102 -15
@@ -140,6 +140,10 @@ MODULE_LICENSE("GPL");#define HCI_WIRELESS_BT_POWER 0x80#define SCI_KBD_MODE_FNZ 0x1#define SCI_KBD_MODE_AUTO 0x2 +#define SCI_KBD_MODE_ON 0x8 +#define SCI_KBD_MODE_OFF 0x10 +#define SCI_KBD_MODE_MAX SCI_KBD_MODE_OFF +#define SCI_KBD_TIME_MAX 0x3c001astruct toshiba_acpi_dev {struct acpi_device *acpi_dev;
@@ -155,6 +159,7 @@ struct toshiba_acpi_dev {int force_fan;int last_key_event;int key_event_valid; +int kbd_type;int kbd_mode;int kbd_time;
@@ -495,6 +500,42 @@ static enum led_brightness toshiba_illumination_get(struct led_classdev *cdev) }/* KBD Illumination */ +static int toshiba_kbd_illum_available (struct toshiba_acpi_dev *dev) +{ +u32 in[HCI_WORDS ] = {SCI_GET ,SCI_KBD_ILLUM_STATUS ,0 ,0 ,0 ,0 }; +u32 out[HCI_WORDS ]; +acpi_status status; + +if (!sci_open (dev)) +return 0 ; + + status =hci_raw (dev, in, out); +sci_close (dev); +if (ACPI_FAILURE (status) || out[0 ] ==SCI_INPUT_DATA_ERROR ) { +pr_err ("ACPI call to query kbd illumination support failed\n" ); +return 0 ; + }else if (out[0 ] ==HCI_NOT_SUPPORTED ) { +pr_info ("Keyboard illumination not available\n" ); +return 0 ; + } + +/* Check for keyboard backlight timeout max value, +/* previous kbd backlight implementation set this to +* 0x3c0003, and now the new implementation set this +* to 0x3c001a, use this to distinguish between them +*/ +if (out[3 ] ==SCI_KBD_TIME_MAX ) + dev->kbd_type =2 ; +else + dev->kbd_type =1 ; +/* Get the current keyboard backlight mode */ + dev->kbd_mode = out[2 ] &SCI_KBD_MODE_MASK ; +/* Get the current time (1-60 seconds) */ + dev->kbd_time = out[2 ] >>HCI_MISC_SHIFT ; + +return 1 ; +} +static int toshiba_kbd_illum_status_set (struct toshiba_acpi_dev *dev,u32 time) {u32 result;
@@ -1268,20 +1309,46 @@ static ssize_t toshiba_kbd_bl_mode_store(struct device *dev, ret =kstrtoint (buf,0 , &mode);if (ret)return ret; -if (mode !=SCI_KBD_MODE_FNZ && mode !=SCI_KBD_MODE_AUTO ) +if (mode !=SCI_KBD_MODE_FNZ && mode !=SCI_KBD_MODE_AUTO && + mode !=SCI_KBD_MODE_ON && mode !=SCI_KBD_MODE_OFF )return -EINVAL ; +/* Check for supported modes depending on keyboard backlight type */ +if (toshiba->kbd_type ==1 ) { +/* Type 1 supports SCI_KBD_MODE_FNZ and SCI_KBD_MODE_AUTO */ +if (mode ==SCI_KBD_MODE_ON || mode ==SCI_KBD_MODE_OFF ) +return -EINVAL ; + }else if (toshiba->kbd_type ==2 ) { +/* Type 2 doesn't support SCI_KBD_MODE_FNZ */ +if (mode ==SCI_KBD_MODE_FNZ ) +return -EINVAL ; + } +/* Set the Keyboard Backlight Mode where: -* Mode - Auto (2) | FN-Z (1) * Auto - KBD backlight turns off automatically in given time * FN-Z - KBD backlight "toggles" when hotkey pressed +* ON - KBD backlight is always on +* OFF - KBD backlight is always off */ + +/* Only make a change if the actual mode has changed */ if (toshiba->kbd_mode != mode) { +/* Shift the time to "base time" (0x3c0000 == 60 seconds) */ time = toshiba->kbd_time <<HCI_MISC_SHIFT ; - time = time + toshiba->kbd_mode; + +/* OR the "base time" to the actual method format */ +if (toshiba->kbd_type ==1 ) { +/* Type 1 requires the current mode */ + time |= toshiba->kbd_mode; + }else if (toshiba->kbd_type ==2 ) { +/* Type 2 requires the desired mode */ + time |= mode; + } + ret =toshiba_kbd_illum_status_set (toshiba, time);if (ret)return ret; + toshiba->kbd_mode = mode; }
@@ -1293,12 +1360,31 @@ static ssize_t toshiba_kbd_bl_mode_show(struct device *dev, char *buf) {struct toshiba_acpi_dev *toshiba =dev_get_drvdata (dev); -u32 time; -if (toshiba_kbd_illum_status_get (toshiba, &time) <0 ) -return -EIO ; +return sprintf (buf,"%x\n" , toshiba->kbd_mode); +} -return sprintf (buf,"%i\n" , time &0x07 ); +static ssize_t toshiba_kbd_type_show (struct device *dev, +struct device_attribute *attr, +char *buf) +{ +struct toshiba_acpi_dev *toshiba =dev_get_drvdata (dev); + +return sprintf (buf,"%d\n" , toshiba->kbd_type); +} + +static ssize_t toshiba_available_kbd_modes_show (struct device *dev, +struct device_attribute *attr, +char *buf) +{ +struct toshiba_acpi_dev *toshiba =dev_get_drvdata (dev); + +if (toshiba->kbd_type ==1 ) +return sprintf (buf,"%x %x\n" , +SCI_KBD_MODE_FNZ ,SCI_KBD_MODE_AUTO ); + +return sprintf (buf,"%x %x %x\n" , +SCI_KBD_MODE_AUTO ,SCI_KBD_MODE_ON ,SCI_KBD_MODE_OFF ); } static ssize_t toshiba_kbd_bl_timeout_store(struct device *dev,
@@ -1390,6 +1476,9 @@ static ssize_t toshiba_position_show(struct device *dev, static DEVICE_ATTR(kbd_backlight_mode, S_IRUGO | S_IWUSR, toshiba_kbd_bl_mode_show, toshiba_kbd_bl_mode_store); +static DEVICE_ATTR(keyboard_type, S_IRUGO, toshiba_kbd_type_show, NULL); +static DEVICE_ATTR(available_kbd_modes, S_IRUGO, + toshiba_available_kbd_modes_show, NULL); static DEVICE_ATTR(kbd_backlight_timeout, S_IRUGO | S_IWUSR, toshiba_kbd_bl_timeout_show, toshiba_kbd_bl_timeout_store); static DEVICE_ATTR(touchpad, S_IRUGO | S_IWUSR,
@@ -1398,6 +1487,8 @@ static DEVICE_ATTR(position, S_IRUGO, toshiba_position_show, NULL);static struct attribute *toshiba_attributes[] = { &dev_attr_kbd_backlight_mode.attr, + &dev_attr_keyboard_type.attr, + &dev_attr_available_kbd_modes.attr, &dev_attr_kbd_backlight_timeout.attr, &dev_attr_touchpad.attr, &dev_attr_position.attr,
@@ -1414,7 +1505,7 @@ static umode_t toshiba_sysfs_is_visible(struct kobject *kobj,if (attr == &dev_attr_kbd_backlight_mode.attr) exists = (drv->kbd_illum_supported) ? true : false;else if (attr == &dev_attr_kbd_backlight_timeout.attr) - exists = (drv->kbd_mode ==SCI_KBD_MODE_AUTO ) ? true : false; + exists = (drv->kbd_mode ==SCI_KBD_MODE_FNZ ) ? false : true;else if (attr == &dev_attr_touchpad.attr) exists = (drv->touchpad_supported) ? true : false;else if (attr == &dev_attr_position.attr)
@@ -1759,15 +1850,11 @@ static int toshiba_acpi_add(struct acpi_device *acpi_dev) dev->eco_supported =1 ; } - ret =toshiba_kbd_illum_status_get (dev, &dummy); -if (!ret) { - dev->kbd_time = dummy >>HCI_MISC_SHIFT ; - dev->kbd_mode = dummy &0x07 ; - } - dev->kbd_illum_supported = !ret; + dev->kbd_illum_supported =toshiba_kbd_illum_available (dev);/* * Only register the LED if KBD illumination is supported -* and the keyboard backlight operation mode is set to FN-Z +* and the keyboard backlight operation mode is set to FN-Z, +* keyboard backlight type 2 returns 0x8400 (HCI WRITE PROTECTED) */ if (dev->kbd_illum_supported && dev->kbd_mode ==SCI_KBD_MODE_FNZ ) { dev->kbd_led.name ="toshiba::kbd_backlight" ;
Signature · 1 line
2.0.0
Azael Avalos
maintainerPATCH v2 5/5 toshiba_acpi: Change touchpad store to check for invalid values
The function toshiba_touchpad_store is not checking for invalid values and simply returns silently.
This patch checks for invalid values and returns accordingly.
--- drivers/platform/x86/toshiba_acpi.c | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-)
drivers/platform/x86/toshiba_acpi.c +10 -4
@@ -1429,12 +1429,18 @@ static ssize_t toshiba_touchpad_store(struct device *dev, {struct toshiba_acpi_dev *toshiba =dev_get_drvdata (dev);int state; +int ret;/* Set the TouchPad on/off, 0 - Disable | 1 - Enable */ -if (sscanf (buf,"%i" , &state) ==1 && (state ==0 || state ==1 )) { -if (toshiba_touchpad_set (toshiba, state) <0 ) -return -EIO ; - } + ret =kstrtoint (buf,0 , &state); +if (ret) +return ret; +if (state !=0 && state !=1 ) +return -EINVAL ; + + ret =toshiba_touchpad_set (toshiba, state); +if (ret) +return ret;return count; }
Signature · 1 line
2.0.0
Darren Hart
AppliedRe: [PATCH v2 5/5] toshiba_acpi: Change touchpad store to check for invalid values
Quoted 6 lines · Azael Avalos
The function
toshiba_touchpad_storeis not checking for invalid values and simply returns silently.This patch checks for invalid values and returns accordingly.
Signed-off-by Azael Avalos <[email protected]>
Queued, thanks Azael!
Signature · 2 lines
Darren Hart Intel Open Source Technology Center
On Wed, Sep 10, 2014 at 09:01:56PM -0600, Azael Avalos wrote:
Hi Azael,
Quoted 56 lines
Newer Toshiba models now come with a new (and different) keyboard backlight implementation with three modes of operation: TIMER, ON and OFF, and the LED is controlled internally by the firmware.
This patch adds support for that type of backlight, changing the existing code to accomodate the new implementation.
The timeout value range is now 1-60 seconds, and the accepted modes are now: 1 (FN-Z), 2 (AUTO or TIMER), 8(ON) and 10 (OFF), this adds two new entries
keyboard_typeandavailable_kbd_modes, the first shows the keyboard type and the latter shows the supported modes depending on the type.Signed-off-by Azael Avalos <[email protected]>--- drivers/platform/x86/toshiba_acpi.c | 117 +++++++++++++++++++++++++++++++----- 1 file changed, 102 insertions(+), 15 deletions(-)drivers/platform/x86/toshiba_acpi.c +16
-0@@ -140,6 +140,10 @@ MODULE_LICENSE("GPL");#define HCI_WIRELESS_BT_POWER 0x80#define SCI_KBD_MODE_FNZ 0x1#define SCI_KBD_MODE_AUTO 0x2 +#define SCI_KBD_MODE_ON 0x8 +#define SCI_KBD_MODE_OFF 0x10 +#define SCI_KBD_MODE_MAX SCI_KBD_MODE_OFF +#define SCI_KBD_TIME_MAX 0x3c001astruct toshiba_acpi_dev {struct acpi_device *acpi_dev;@@ -155,6 +159,7 @@ struct toshiba_acpi_dev {int force_fan;int last_key_event;int key_event_valid; +int kbd_type;int kbd_mode;int kbd_time;@@ -495,6 +500,42 @@ static enum led_brightness toshiba_illumination_get(struct led_classdev *cdev) }/* KBD Illumination */ +static int toshiba_kbd_illum_available (struct toshiba_acpi_dev *dev) +{ +u32 in[HCI_WORDS ] = {SCI_GET ,SCI_KBD_ILLUM_STATUS ,0 ,0 ,0 ,0 }; +u32 out[HCI_WORDS ]; +acpi_status status; + +if (!sci_open (dev)) +return 0 ; + + status =hci_raw (dev, in, out); +sci_close (dev);
drivers/platform/x86/toshiba_acpi.c static enum led_brightness toshiba_illumination_get(struct led_classdev *cdev) · line 523
Quoted 10 lines
drivers/platform/x86/toshiba_acpi.c +10
-0+if (ACPI_FAILURE (status) || out[0 ] ==SCI_INPUT_DATA_ERROR ) { +pr_err ("ACPI call to query kbd illumination support failed\n" ); +return 0 ; + }else if (out[0 ] ==HCI_NOT_SUPPORTED ) { +pr_info ("Keyboard illumination not available\n" ); +return 0 ; + } + +/* Check for keyboard backlight timeout max value, +/* previous kbd backlight implementation set this to
Extra / ^
Quoted 19 lines
drivers/platform/x86/toshiba_acpi.c +15
-0+* 0x3c0003, and now the new implementation set this +* to 0x3c001a, use this to distinguish between them +*/ +if (out[3 ] ==SCI_KBD_TIME_MAX ) + dev->kbd_type =2 ; +else + dev->kbd_type =1 ; +/* Get the current keyboard backlight mode */ + dev->kbd_mode = out[2 ] &SCI_KBD_MODE_MASK ; +/* Get the current time (1-60 seconds) */ + dev->kbd_time = out[2 ] >>HCI_MISC_SHIFT ; + +return 1 ; +} +static int toshiba_kbd_illum_status_set (struct toshiba_acpi_dev *dev,u32 time) {u32 result;
drivers/platform/x86/toshiba_acpi.c static ssize_t toshiba_kbd_bl_mode_store(struct device *dev, · line 1314
Quoted 7 lines
drivers/platform/x86/toshiba_acpi.c +2
-1@@ -1268,20 +1309,46 @@ static ssize_t toshiba_kbd_bl_mode_store(struct device *dev, ret =kstrtoint (buf,0 , &mode);if (ret)return ret; -if (mode !=SCI_KBD_MODE_FNZ && mode !=SCI_KBD_MODE_AUTO ) +if (mode !=SCI_KBD_MODE_FNZ && mode !=SCI_KBD_MODE_AUTO && + mode !=SCI_KBD_MODE_ON && mode !=SCI_KBD_MODE_OFF )return -EINVAL ;
Since you have to check for a type::mode match anyway, this initial test is redundant. I suggest inverting the type::mode match below and make it exhaustive, something like:
drivers/platform/x86/toshiba_acpi.c static ssize_t toshiba_kbd_bl_mode_store(struct device *dev, · line 1319
Quoted 5 lines
drivers/platform/x86/toshiba_acpi.c +4
-0+/* Check for supported modes depending on keyboard backlight type */ +if (toshiba->kbd_type ==1 ) { +/* Type 1 supports SCI_KBD_MODE_FNZ and SCI_KBD_MODE_AUTO */ +if (mode ==SCI_KBD_MODE_ON || mode ==SCI_KBD_MODE_OFF )
if (mode != SCI_KBD_MODE_FNZ && mode != SCI_KBD_MODE_AUTO)
The net number of tests is ultimately smaller and it's fewer lines of code.
Quoted 38 lines
drivers/platform/x86/toshiba_acpi.c +23
-2+return -EINVAL ; + }else if (toshiba->kbd_type ==2 ) { +/* Type 2 doesn't support SCI_KBD_MODE_FNZ */ +if (mode ==SCI_KBD_MODE_FNZ ) +return -EINVAL ; + } +/* Set the Keyboard Backlight Mode where: -* Mode - Auto (2) | FN-Z (1) * Auto - KBD backlight turns off automatically in given time * FN-Z - KBD backlight "toggles" when hotkey pressed +* ON - KBD backlight is always on +* OFF - KBD backlight is always off */ + +/* Only make a change if the actual mode has changed */ if (toshiba->kbd_mode != mode) { +/* Shift the time to "base time" (0x3c0000 == 60 seconds) */ time = toshiba->kbd_time <<HCI_MISC_SHIFT ; - time = time + toshiba->kbd_mode; + +/* OR the "base time" to the actual method format */ +if (toshiba->kbd_type ==1 ) { +/* Type 1 requires the current mode */ + time |= toshiba->kbd_mode; + }else if (toshiba->kbd_type ==2 ) { +/* Type 2 requires the desired mode */ + time |= mode; + } + ret =toshiba_kbd_illum_status_set (toshiba, time);if (ret)return ret; + toshiba->kbd_mode = mode; }
drivers/platform/x86/toshiba_acpi.c static ssize_t toshiba_kbd_bl_mode_show(struct device *dev, · line 1364
Quoted 8 lines
drivers/platform/x86/toshiba_acpi.c +1
-3@@ -1293,12 +1360,31 @@ static ssize_t toshiba_kbd_bl_mode_show(struct device *dev, char *buf) {struct toshiba_acpi_dev *toshiba =dev_get_drvdata (dev); -u32 time; -if (toshiba_kbd_illum_status_get (toshiba, &time) <0 ) -return -EIO ; +return sprintf (buf,"%x\n" , toshiba->kbd_mode);
I understand this isn't new, and I don't see an obvious path to failure - have you verified dev_get_drvdata CANNOT return NULL or a bad pointer ever?
Quoted 28 lines
drivers/platform/x86/toshiba_acpi.c +22
-1+} -return sprintf (buf,"%i\n" , time &0x07 ); +static ssize_t toshiba_kbd_type_show (struct device *dev, +struct device_attribute *attr, +char *buf) +{ +struct toshiba_acpi_dev *toshiba =dev_get_drvdata (dev); + +return sprintf (buf,"%d\n" , toshiba->kbd_type); +} + +static ssize_t toshiba_available_kbd_modes_show (struct device *dev, +struct device_attribute *attr, +char *buf) +{ +struct toshiba_acpi_dev *toshiba =dev_get_drvdata (dev); + +if (toshiba->kbd_type ==1 ) +return sprintf (buf,"%x %x\n" , +SCI_KBD_MODE_FNZ ,SCI_KBD_MODE_AUTO ); + +return sprintf (buf,"%x %x %x\n" , +SCI_KBD_MODE_AUTO ,SCI_KBD_MODE_ON ,SCI_KBD_MODE_OFF ); } static ssize_t toshiba_kbd_bl_timeout_store(struct device *dev,
drivers/platform/x86/toshiba_acpi.c static ssize_t toshiba_position_show(struct device *dev, · line 1481
Quoted 6 lines
drivers/platform/x86/toshiba_acpi.c +3
-0@@ -1390,6 +1476,9 @@ static ssize_t toshiba_position_show(struct device *dev, static DEVICE_ATTR(kbd_backlight_mode, S_IRUGO | S_IWUSR, toshiba_kbd_bl_mode_show, toshiba_kbd_bl_mode_store); +static DEVICE_ATTR(keyboard_type, S_IRUGO, toshiba_kbd_type_show, NULL); +static DEVICE_ATTR(available_kbd_modes, S_IRUGO, + toshiba_available_kbd_modes_show, NULL);
Please keep the naming as consistent as possible. We're using "kbd" here instead of "keyboard" here for most everything else.
A user may not key-in that kbd_backlight_mode is the setting and the options are available_kbd_modes, since kbd_backlight_mode could conceivably be different from kbd_modes. Let's make it very easy for someone trying to discover this interface by using consistent terminology throughout.
Quoted 13 lines
drivers/platform/x86/toshiba_acpi.c +2
-0static DEVICE_ATTR(kbd_backlight_timeout, S_IRUGO | S_IWUSR, toshiba_kbd_bl_timeout_show, toshiba_kbd_bl_timeout_store); static DEVICE_ATTR(touchpad, S_IRUGO | S_IWUSR,@@ -1398,6 +1487,8 @@ static DEVICE_ATTR(position, S_IRUGO, toshiba_position_show, NULL);static struct attribute *toshiba_attributes[] = { &dev_attr_kbd_backlight_mode.attr, + &dev_attr_keyboard_type.attr, + &dev_attr_available_kbd_modes.attr, &dev_attr_kbd_backlight_timeout.attr, &dev_attr_touchpad.attr, &dev_attr_position.attr,
drivers/platform/x86/toshiba_acpi.c static umode_t toshiba_sysfs_is_visible(struct kobject *kobj, · line 1508
Quoted 5 lines
drivers/platform/x86/toshiba_acpi.c +1
-1@@ -1414,7 +1505,7 @@ static umode_t toshiba_sysfs_is_visible(struct kobject *kobj,if (attr == &dev_attr_kbd_backlight_mode.attr) exists = (drv->kbd_illum_supported) ? true : false;else if (attr == &dev_attr_kbd_backlight_timeout.attr) - exists = (drv->kbd_mode ==SCI_KBD_MODE_AUTO ) ? true : false; + exists = (drv->kbd_mode ==SCI_KBD_MODE_FNZ ) ? false : true;
Is this correct? This would mean a timeout is available even if mode is OFF?
Quoted 9 lines
drivers/platform/x86/toshiba_acpi.c +0
-2else if (attr == &dev_attr_touchpad.attr) exists = (drv->touchpad_supported) ? true : false;else if (attr == &dev_attr_position.attr)@@ -1759,15 +1850,11 @@ static int toshiba_acpi_add(struct acpi_device *acpi_dev) dev->eco_supported =1 ; } - ret =toshiba_kbd_illum_status_get (dev, &dummy); -if (!ret) {
drivers/platform/x86/toshiba_acpi.c static int toshiba_acpi_add(struct acpi_device *acpi_dev) · line 1857
Quoted 10 lines
drivers/platform/x86/toshiba_acpi.c +3
-5- dev->kbd_time = dummy >>HCI_MISC_SHIFT ; - dev->kbd_mode = dummy &0x07 ; - } - dev->kbd_illum_supported = !ret; + dev->kbd_illum_supported =toshiba_kbd_illum_available (dev);/* * Only register the LED if KBD illumination is supported -* and the keyboard backlight operation mode is set to FN-Z +* and the keyboard backlight operation mode is set to FN-Z, +* keyboard backlight type 2 returns 0x8400 (HCI WRITE PROTECTED)
Hrm, I'm not following how this relates to the code block that follows...
Thanks Azael,
Signature · 2 lines
Darren Hart Intel Open Source Technology Center
Azael Avalos
maintainerHi Darren,
2014-09-11 18:36 GMT-06:00 Darren Hart <[email protected]>:
Quoted 111 lines · Azael Avalos
Hi Azael,
Quoted 56 lines
Newer Toshiba models now come with a new (and different) keyboard backlight implementation with three modes of operation: TIMER, ON and OFF, and the LED is controlled internally by the firmware.
This patch adds support for that type of backlight, changing the existing code to accomodate the new implementation.
The timeout value range is now 1-60 seconds, and the accepted modes are now: 1 (FN-Z), 2 (AUTO or TIMER), 8(ON) and 10 (OFF), this adds two new entries
keyboard_typeandavailable_kbd_modes, the first shows the keyboard type and the latter shows the supported modes depending on the type.Signed-off-by Azael Avalos <[email protected]>--- drivers/platform/x86/toshiba_acpi.c | 117 +++++++++++++++++++++++++++++++----- 1 file changed, 102 insertions(+), 15 deletions(-)drivers/platform/x86/toshiba_acpi.c +16
-0@@ -140,6 +140,10 @@ MODULE_LICENSE("GPL");#define HCI_WIRELESS_BT_POWER 0x80#define SCI_KBD_MODE_FNZ 0x1#define SCI_KBD_MODE_AUTO 0x2 +#define SCI_KBD_MODE_ON 0x8 +#define SCI_KBD_MODE_OFF 0x10 +#define SCI_KBD_MODE_MAX SCI_KBD_MODE_OFF +#define SCI_KBD_TIME_MAX 0x3c001astruct toshiba_acpi_dev {struct acpi_device *acpi_dev;@@ -155,6 +159,7 @@ struct toshiba_acpi_dev {int force_fan;int last_key_event;int key_event_valid; +int kbd_type;int kbd_mode;int kbd_time;@@ -495,6 +500,42 @@ static enum led_brightness toshiba_illumination_get(struct led_classdev *cdev) }/* KBD Illumination */ +static int toshiba_kbd_illum_available (struct toshiba_acpi_dev *dev) +{ +u32 in[HCI_WORDS ] = {SCI_GET ,SCI_KBD_ILLUM_STATUS ,0 ,0 ,0 ,0 }; +u32 out[HCI_WORDS ]; +acpi_status status; + +if (!sci_open (dev)) +return 0 ; + + status =hci_raw (dev, in, out); +sci_close (dev);drivers/platform/x86/toshiba_acpi.c static enum led_brightness toshiba_illumination_get(struct led_classdev *cdev) · line 523
Quoted 10 lines
drivers/platform/x86/toshiba_acpi.c +10
-0+if (ACPI_FAILURE (status) || out[0 ] ==SCI_INPUT_DATA_ERROR ) { +pr_err ("ACPI call to query kbd illumination support failed\n" ); +return 0 ; + }else if (out[0 ] ==HCI_NOT_SUPPORTED ) { +pr_info ("Keyboard illumination not available\n" ); +return 0 ; + } + +/* Check for keyboard backlight timeout max value, +/* previous kbd backlight implementation set this to Extra / ^
Quoted 19 lines
drivers/platform/x86/toshiba_acpi.c +15
-0+* 0x3c0003, and now the new implementation set this +* to 0x3c001a, use this to distinguish between them +*/ +if (out[3 ] ==SCI_KBD_TIME_MAX ) + dev->kbd_type =2 ; +else + dev->kbd_type =1 ; +/* Get the current keyboard backlight mode */ + dev->kbd_mode = out[2 ] &SCI_KBD_MODE_MASK ; +/* Get the current time (1-60 seconds) */ + dev->kbd_time = out[2 ] >>HCI_MISC_SHIFT ; + +return 1 ; +} +static int toshiba_kbd_illum_status_set (struct toshiba_acpi_dev *dev,u32 time) {u32 result;drivers/platform/x86/toshiba_acpi.c static ssize_t toshiba_kbd_bl_mode_store(struct device *dev, · line 1314
Quoted 7 lines
drivers/platform/x86/toshiba_acpi.c +2
-1@@ -1268,20 +1309,46 @@ static ssize_t toshiba_kbd_bl_mode_store(struct device *dev, ret =kstrtoint (buf,0 , &mode);if (ret)return ret; -if (mode !=SCI_KBD_MODE_FNZ && mode !=SCI_KBD_MODE_AUTO ) +if (mode !=SCI_KBD_MODE_FNZ && mode !=SCI_KBD_MODE_AUTO && + mode !=SCI_KBD_MODE_ON && mode !=SCI_KBD_MODE_OFF )return -EINVAL ;Since you have to check for a
type::modematch anyway, this initial test is redundant. I suggest inverting thetype::modematch below and make it exhaustive, something like:drivers/platform/x86/toshiba_acpi.c static ssize_t toshiba_kbd_bl_mode_store(struct device *dev, · line 1319
Quoted 5 lines
drivers/platform/x86/toshiba_acpi.c +4
-0+/* Check for supported modes depending on keyboard backlight type */ +if (toshiba->kbd_type ==1 ) { +/* Type 1 supports SCI_KBD_MODE_FNZ and SCI_KBD_MODE_AUTO */ +if (mode ==SCI_KBD_MODE_ON || mode ==SCI_KBD_MODE_OFF )
Quoted 4 lines
if (mode != SCI_KBD_MODE_FNZ && mode != SCI_KBD_MODE_AUTO)The net number of tests is ultimately smaller and it's fewer lines of code.
Ok
Quoted 44 lines
Quoted 44 lines
drivers/platform/x86/toshiba_acpi.c +23
-3+return -EINVAL ; + }else if (toshiba->kbd_type ==2 ) { +/* Type 2 doesn't support SCI_KBD_MODE_FNZ */ +if (mode ==SCI_KBD_MODE_FNZ ) +return -EINVAL ; + } +/* Set the Keyboard Backlight Mode where: -* Mode - Auto (2) | FN-Z (1) * Auto - KBD backlight turns off automatically in given time * FN-Z - KBD backlight "toggles" when hotkey pressed +* ON - KBD backlight is always on +* OFF - KBD backlight is always off */ + +/* Only make a change if the actual mode has changed */ if (toshiba->kbd_mode != mode) { +/* Shift the time to "base time" (0x3c0000 == 60 seconds) */ time = toshiba->kbd_time <<HCI_MISC_SHIFT ; - time = time + toshiba->kbd_mode; + +/* OR the "base time" to the actual method format */ +if (toshiba->kbd_type ==1 ) { +/* Type 1 requires the current mode */ + time |= toshiba->kbd_mode; + }else if (toshiba->kbd_type ==2 ) { +/* Type 2 requires the desired mode */ + time |= mode; + } + ret =toshiba_kbd_illum_status_set (toshiba, time);if (ret)return ret; + toshiba->kbd_mode = mode; }@@ -1293,12 +1360,31 @@ static ssize_t toshiba_kbd_bl_mode_show(struct device *dev, char *buf) {struct toshiba_acpi_dev *toshiba =dev_get_drvdata (dev); -u32 time;
Quoted 8 lines
drivers/platform/x86/toshiba_acpi.c static ssize_t toshiba_kbd_bl_mode_show(struct device *dev, · line 1364
Quoted 3 lines
drivers/platform/x86/toshiba_acpi.c +1
-2-if (toshiba_kbd_illum_status_get (toshiba, &time) <0 ) -return -EIO ; +return sprintf (buf,"%x\n" , toshiba->kbd_mode);I understand this isn't new, and I don't see an obvious path to failure - have you verified
dev_get_drvdataCANNOT return NULL or a bad pointer ever?
Well, since we are using dev_set_drvdata on startup (toshiba_acpi_add), it should never return a bad pointer, however, lets play on the safe side and I'll add a check for NULL because that's what dev_get_drvdata returns in case of a non valid pointer
Quoted 31 lines
Quoted 31 lines
drivers/platform/x86/toshiba_acpi.c +22
-1+} -return sprintf (buf,"%i\n" , time &0x07 ); +static ssize_t toshiba_kbd_type_show (struct device *dev, +struct device_attribute *attr, +char *buf) +{ +struct toshiba_acpi_dev *toshiba =dev_get_drvdata (dev); + +return sprintf (buf,"%d\n" , toshiba->kbd_type); +} + +static ssize_t toshiba_available_kbd_modes_show (struct device *dev, +struct device_attribute *attr, +char *buf) +{ +struct toshiba_acpi_dev *toshiba =dev_get_drvdata (dev); + +if (toshiba->kbd_type ==1 ) +return sprintf (buf,"%x %x\n" , +SCI_KBD_MODE_FNZ ,SCI_KBD_MODE_AUTO ); + +return sprintf (buf,"%x %x %x\n" , +SCI_KBD_MODE_AUTO ,SCI_KBD_MODE_ON ,SCI_KBD_MODE_OFF ); } static ssize_t toshiba_kbd_bl_timeout_store(struct device *dev,@@ -1390,6 +1476,9 @@ static ssize_t toshiba_position_show(struct device *dev,
Quoted 9 lines
drivers/platform/x86/toshiba_acpi.c static ssize_t toshiba_position_show(struct device *dev, · line 1481
Quoted 5 lines
drivers/platform/x86/toshiba_acpi.c +3
-0static DEVICE_ATTR(kbd_backlight_mode, S_IRUGO | S_IWUSR, toshiba_kbd_bl_mode_show, toshiba_kbd_bl_mode_store); +static DEVICE_ATTR(keyboard_type, S_IRUGO, toshiba_kbd_type_show, NULL); +static DEVICE_ATTR(available_kbd_modes, S_IRUGO, + toshiba_available_kbd_modes_show, NULL);Please keep the naming as consistent as possible. We're using "kbd" here instead of "keyboard" here for most everything else.
Ok
Quoted 12 lines
A user may not key-in that
kbd_backlight_modeis the setting and the options areavailable_kbd_modes, sincekbd_backlight_modecould conceivably be different fromkbd_modes. Let's make it very easy for someone trying to discover this interface by using consistent terminology throughout.Quoted 5 lines
drivers/platform/x86/toshiba_acpi.c +0
-0static DEVICE_ATTR(kbd_backlight_timeout, S_IRUGO | S_IWUSR, toshiba_kbd_bl_timeout_show, toshiba_kbd_bl_timeout_store); static DEVICE_ATTR(touchpad, S_IRUGO | S_IWUSR,@@ -1398,6 +1487,8 @@ static DEVICE_ATTR(position, S_IRUGO, toshiba_position_show, NULL);
Quoted 15 lines
drivers/platform/x86/toshiba_acpi.c static umode_t toshiba_sysfs_is_visible(struct kobject *kobj, · line 1508
Quoted 13 lines
drivers/platform/x86/toshiba_acpi.c +3
-1static struct attribute *toshiba_attributes[] = { &dev_attr_kbd_backlight_mode.attr, + &dev_attr_keyboard_type.attr, + &dev_attr_available_kbd_modes.attr, &dev_attr_kbd_backlight_timeout.attr, &dev_attr_touchpad.attr, &dev_attr_position.attr,@@ -1414,7 +1505,7 @@ static umode_t toshiba_sysfs_is_visible(struct kobject *kobj,if (attr == &dev_attr_kbd_backlight_mode.attr) exists = (drv->kbd_illum_supported) ? true : false;else if (attr == &dev_attr_kbd_backlight_timeout.attr) - exists = (drv->kbd_mode ==SCI_KBD_MODE_AUTO ) ? true : false; + exists = (drv->kbd_mode ==SCI_KBD_MODE_FNZ ) ? false : true;Is this correct? This would mean a timeout is available even if mode is OFF?
Right now yes, as I wasn't sure if I could create/delete files from sysfs, so perhaps whenever the user is not on AUTO call sysfs_update_group and leave toshiba_sysfs_is_visible as it was.
Quoted 9 lines
Quoted 9 lines
drivers/platform/x86/toshiba_acpi.c +0
-0else if (attr == &dev_attr_touchpad.attr) exists = (drv->touchpad_supported) ? true : false;else if (attr == &dev_attr_position.attr)@@ -1759,15 +1850,11 @@ static int toshiba_acpi_add(struct acpi_device *acpi_dev) dev->eco_supported =1 ; }
Quoted 14 lines
drivers/platform/x86/toshiba_acpi.c static int toshiba_acpi_add(struct acpi_device *acpi_dev) · line 1857
Quoted 12 lines
drivers/platform/x86/toshiba_acpi.c +3
-7- ret =toshiba_kbd_illum_status_get (dev, &dummy); -if (!ret) { - dev->kbd_time = dummy >>HCI_MISC_SHIFT ; - dev->kbd_mode = dummy &0x07 ; - } - dev->kbd_illum_supported = !ret; + dev->kbd_illum_supported =toshiba_kbd_illum_available (dev);/* * Only register the LED if KBD illumination is supported -* and the keyboard backlight operation mode is set to FN-Z +* and the keyboard backlight operation mode is set to FN-Z, +* keyboard backlight type 2 returns 0x8400 (HCI WRITE PROTECTED) Hrm, I'm not following how this relates to the code block that follows...
I just wanted to place a note for others reading the code, the kbd led method is always available, so if someone else tries to expose the kbd led to userspace on kbd bl type 2, it will return a write protected error on writing (reading is always accessible).
Quoted 6 lines
Thanks Azael,
--
Darren Hart
Intel Open Source Technology Center
I'll re-send an updated patch with the observations mentioned here, and also adding an extra line of code that went missing.
Cheers
Azael
Signature · 1 line
-- El mundo apesta y vosotros apestais tambien --