root/drivers/platform/x86/panasonic-laptop.c
// SPDX-License-Identifier: GPL-2.0-only
/*
 *  Panasonic HotKey and LCD brightness control driver
 *  (C) 2004 Hiroshi Miura <miura@da-cha.org>
 *  (C) 2004 NTT DATA Intellilink Co. http://www.intellilink.co.jp/
 *  (C) YOKOTA Hiroshi <yokota (at) netlab. is. tsukuba. ac. jp>
 *  (C) 2004 David Bronaugh <dbronaugh>
 *  (C) 2006-2008 Harald Welte <laforge@gnumonks.org>
 *
 *  derived from toshiba_acpi.c, Copyright (C) 2002-2004 John Belmonte
 *
 *---------------------------------------------------------------------------
 *
 * ChangeLog:
 *      Aug.18, 2020    Kenneth Chan <kenneth.t.chan@gmail.com>
 *              -v0.98  add platform devices for firmware brightness registers
 *                      add support for battery charging threshold (eco mode)
 *                      resolve hotkey double trigger
 *                      add write support to mute
 *                      fix sticky_key init bug
 *                      fix naming of platform files for consistency with other
 *                      modules
 *                      split MODULE_AUTHOR() by one author per macro call
 *                      replace ACPI prints with pr_*() macros
 *              -v0.97  add support for cdpower hardware switch
 *              -v0.96  merge Lucina's enhancement
 *                      Jan.13, 2009 Martin Lucina <mato@kotelna.sk>
 *                              - add support for optical driver power in
 *                                Y and W series
 *
 *      Sep.23, 2008    Harald Welte <laforge@gnumonks.org>
 *              -v0.95  rename driver from drivers/acpi/pcc_acpi.c to
 *                      drivers/misc/panasonic-laptop.c
 *
 *      Jul.04, 2008    Harald Welte <laforge@gnumonks.org>
 *              -v0.94  replace /proc interface with device attributes
 *                      support {set,get}keycode on th input device
 *
 *      Jun.27, 2008    Harald Welte <laforge@gnumonks.org>
 *              -v0.92  merge with 2.6.26-rc6 input API changes
 *                      remove broken <= 2.6.15 kernel support
 *                      resolve all compiler warnings
 *                      various coding style fixes (checkpatch.pl)
 *                      add support for backlight api
 *                      major code restructuring
 *
 *      Dac.28, 2007    Harald Welte <laforge@gnumonks.org>
 *              -v0.91  merge with 2.6.24-rc6 ACPI changes
 *
 *      Nov.04, 2006    Hiroshi Miura <miura@da-cha.org>
 *              -v0.9   remove warning about section reference.
 *                      remove acpi_os_free
 *                      add /proc/acpi/pcc/brightness interface for HAL access
 *                      merge dbronaugh's enhancement
 *                      Aug.17, 2004 David Bronaugh (dbronaugh)
 *                              - Added screen brightness setting interface
 *                                Thanks to FreeBSD crew (acpi_panasonic.c)
 *                                for the ideas I needed to accomplish it
 *
 *      May.29, 2006    Hiroshi Miura <miura@da-cha.org>
 *              -v0.8.4 follow to change keyinput structure
 *                      thanks Fabian Yamaguchi <fabs@cs.tu-berlin.de>,
 *                      Jacob Bower <jacob.bower@ic.ac.uk> and
 *                      Hiroshi Yokota for providing solutions.
 *
 *      Oct.02, 2004    Hiroshi Miura <miura@da-cha.org>
 *              -v0.8.2 merge code of YOKOTA Hiroshi
 *                                      <yokota@netlab.is.tsukuba.ac.jp>.
 *                      Add sticky key mode interface.
 *                      Refactoring acpi_pcc_generate_keyinput().
 *
 *      Sep.15, 2004    Hiroshi Miura <miura@da-cha.org>
 *              -v0.8   Generate key input event on input subsystem.
 *                      This is based on yet another driver written by
 *                                                      Ryuta Nakanishi.
 *
 *      Sep.10, 2004    Hiroshi Miura <miura@da-cha.org>
 *              -v0.7   Change proc interface functions using seq_file
 *                      facility as same as other ACPI drivers.
 *
 *      Aug.28, 2004    Hiroshi Miura <miura@da-cha.org>
 *              -v0.6.4 Fix a silly error with status checking
 *
 *      Aug.25, 2004    Hiroshi Miura <miura@da-cha.org>
 *              -v0.6.3 replace read_acpi_int by standard function
 *                                                      acpi_evaluate_integer
 *                      some clean up and make smart copyright notice.
 *                      fix return value of pcc_acpi_get_key()
 *                      fix checking return value of acpi_bus_register_driver()
 *
 *      Aug.22, 2004    David Bronaugh <dbronaugh@linuxboxen.org>
 *              -v0.6.2 Add check on ACPI data (num_sifr)
 *                      Coding style cleanups, better error messages/handling
 *                      Fixed an off-by-one error in memory allocation
 *
 *      Aug.21, 2004    David Bronaugh <dbronaugh@linuxboxen.org>
 *              -v0.6.1 Fix a silly error with status checking
 *
 *      Aug.20, 2004    David Bronaugh <dbronaugh@linuxboxen.org>
 *              - v0.6  Correct brightness controls to reflect reality
 *                      based on information gleaned by Hiroshi Miura
 *                      and discussions with Hiroshi Miura
 *
 *      Aug.10, 2004    Hiroshi Miura <miura@da-cha.org>
 *              - v0.5  support LCD brightness control
 *                      based on the disclosed information by MEI.
 *
 *      Jul.25, 2004    Hiroshi Miura <miura@da-cha.org>
 *              - v0.4  first post version
 *                      add function to retrive SIFR
 *
 *      Jul.24, 2004    Hiroshi Miura <miura@da-cha.org>
 *              - v0.3  get proper status of hotkey
 *
 *      Jul.22, 2004    Hiroshi Miura <miura@da-cha.org>
 *              - v0.2  add HotKey handler
 *
 *      Jul.17, 2004    Hiroshi Miura <miura@da-cha.org>
 *              - v0.1  start from toshiba_acpi driver written by John Belmonte
 */

#include <linux/acpi.h>
#include <linux/backlight.h>
#include <linux/bits.h>
#include <linux/ctype.h>
#include <linux/i8042.h>
#include <linux/init.h>
#include <linux/input.h>
#include <linux/input/sparse-keymap.h>
#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/platform_device.h>
#include <linux/seq_file.h>
#include <linux/serio.h>
#include <linux/slab.h>
#include <linux/types.h>
#include <linux/uaccess.h>
#include <acpi/video.h>

MODULE_AUTHOR("Hiroshi Miura <miura@da-cha.org>");
MODULE_AUTHOR("David Bronaugh <dbronaugh@linuxboxen.org>");
MODULE_AUTHOR("Harald Welte <laforge@gnumonks.org>");
MODULE_AUTHOR("Martin Lucina <mato@kotelna.sk>");
MODULE_AUTHOR("Kenneth Chan <kenneth.t.chan@gmail.com>");
MODULE_DESCRIPTION("ACPI HotKey driver for Panasonic Let's Note laptops");
MODULE_LICENSE("GPL");

#define LOGPREFIX "pcc_acpi: "

/* Define ACPI PATHs */
/* Lets note hotkeys */
#define METHOD_HKEY_QUERY       "HINF"
#define METHOD_HKEY_SQTY        "SQTY"
#define METHOD_HKEY_SINF        "SINF"
#define METHOD_HKEY_SSET        "SSET"
#define METHOD_ECWR             "\\_SB.ECWR"
#define HKEY_NOTIFY             0x80
#define ECO_MODE_OFF            0x00
#define ECO_MODE_ON             0x80

#define ACPI_PCC_DRIVER_NAME    "Panasonic Laptop Support"
#define ACPI_PCC_DEVICE_NAME    "Hotkey"
#define ACPI_PCC_CLASS          "pcc"

#define ACPI_PCC_INPUT_PHYS     "panasonic/hkey0"

/* LCD_TYPEs: 0 = Normal, 1 = Semi-transparent
   ECO_MODEs: 0x03 = off, 0x83 = on
*/
enum SINF_BITS { SINF_NUM_BATTERIES = 0,
                 SINF_LCD_TYPE,
                 SINF_AC_MAX_BRIGHT,
                 SINF_AC_MIN_BRIGHT,
                 SINF_AC_CUR_BRIGHT,
                 SINF_DC_MAX_BRIGHT,
                 SINF_DC_MIN_BRIGHT,
                 SINF_DC_CUR_BRIGHT,
                 SINF_MUTE,
                 SINF_RESERVED,
                 SINF_ECO_MODE = 0x0A,
                 SINF_CUR_BRIGHT = 0x0D,
                 SINF_STICKY_KEY = 0x80,
        };
/* R1 handles SINF_AC_CUR_BRIGHT as SINF_CUR_BRIGHT, doesn't know AC state */

static int acpi_pcc_hotkey_add(struct acpi_device *device);
static void acpi_pcc_hotkey_remove(struct acpi_device *device);
static void acpi_pcc_hotkey_notify(struct acpi_device *device, u32 event);

static const struct acpi_device_id pcc_device_ids[] = {
        { "MAT0012", 0},
        { "MAT0013", 0},
        { "MAT0018", 0},
        { "MAT0019", 0},
        { "", 0},
};
MODULE_DEVICE_TABLE(acpi, pcc_device_ids);

#ifdef CONFIG_PM_SLEEP
static int acpi_pcc_hotkey_resume(struct device *dev);
#endif
static SIMPLE_DEV_PM_OPS(acpi_pcc_hotkey_pm, NULL, acpi_pcc_hotkey_resume);

static struct acpi_driver acpi_pcc_driver = {
        .name =         ACPI_PCC_DRIVER_NAME,
        .class =        ACPI_PCC_CLASS,
        .ids =          pcc_device_ids,
        .ops =          {
                                .add =          acpi_pcc_hotkey_add,
                                .remove =       acpi_pcc_hotkey_remove,
                                .notify =       acpi_pcc_hotkey_notify,
                        },
        .drv.pm =       &acpi_pcc_hotkey_pm,
};

static const struct key_entry panasonic_keymap[] = {
        { KE_KEY, 0, { KEY_RESERVED } },
        { KE_KEY, 1, { KEY_BRIGHTNESSDOWN } },
        { KE_KEY, 2, { KEY_BRIGHTNESSUP } },
        { KE_KEY, 3, { KEY_DISPLAYTOGGLE } },
        { KE_KEY, 4, { KEY_MUTE } },
        { KE_KEY, 5, { KEY_VOLUMEDOWN } },
        { KE_KEY, 6, { KEY_VOLUMEUP } },
        { KE_KEY, 7, { KEY_SLEEP } },
        { KE_KEY, 8, { KEY_PROG1 } }, /* Change CPU boost */
        { KE_KEY, 9, { KEY_BATTERY } },
        { KE_KEY, 10, { KEY_SUSPEND } },
        { KE_KEY, 21, { KEY_MACRO1 } },
        { KE_KEY, 22, { KEY_MACRO2 } },
        { KE_KEY, 24, { KEY_MACRO3 } },
        { KE_KEY, 25, { KEY_MACRO4 } },
        { KE_KEY, 34, { KEY_MACRO5 } },
        { KE_KEY, 35, { KEY_MACRO6 } },
        { KE_KEY, 36, { KEY_MACRO7 } },
        { KE_KEY, 37, { KEY_MACRO8 } },
        { KE_KEY, 41, { KEY_MACRO9 } },
        { KE_KEY, 42, { KEY_MACRO10 } },
        { KE_KEY, 43, { KEY_MACRO11 } },
        { KE_END, 0 }
};

struct pcc_acpi {
        acpi_handle             handle;
        unsigned long           num_sifr;
        int                     sticky_key;
        int                     eco_mode;
        int                     mute;
        int                     ac_brightness;
        int                     dc_brightness;
        int                     current_brightness;
        u32                     *sinf;
        struct acpi_device      *device;
        struct input_dev        *input_dev;
        struct backlight_device *backlight;
        struct platform_device  *platform;
};

/*
 * On some Panasonic models the volume up / down / mute keys send duplicate
 * keypress events over the PS/2 kbd interface, filter these out.
 */
static bool panasonic_i8042_filter(unsigned char data, unsigned char str,
                                   struct serio *port, void *context)
{
        static bool extended;

        if (str & I8042_STR_AUXDATA)
                return false;

        if (data == 0xe0) {
                extended = true;
                return true;
        } else if (extended) {
                extended = false;

                switch (data & 0x7f) {
                case 0x20: /* e0 20 / e0 a0, Volume Mute press / release */
                case 0x2e: /* e0 2e / e0 ae, Volume Down press / release */
                case 0x30: /* e0 30 / e0 b0, Volume Up press / release */
                        return true;
                default:
                        /*
                         * Report the previously filtered e0 before continuing
                         * with the next non-filtered byte.
                         */
                        serio_interrupt(port, 0xe0, 0);
                        return false;
                }
        }

        return false;
}

/* method access functions */
static int acpi_pcc_write_sset(struct pcc_acpi *pcc, int func, int val)
{
        union acpi_object in_objs[] = {
                { .integer.type  = ACPI_TYPE_INTEGER,
                  .integer.value = func, },
                { .integer.type  = ACPI_TYPE_INTEGER,
                  .integer.value = val, },
        };
        struct acpi_object_list params = {
                .count   = ARRAY_SIZE(in_objs),
                .pointer = in_objs,
        };
        acpi_status status = AE_OK;

        status = acpi_evaluate_object(pcc->handle, METHOD_HKEY_SSET,
                                      &params, NULL);

        return (status == AE_OK) ? 0 : -EIO;
}

static inline int acpi_pcc_get_sqty(struct acpi_device *device)
{
        unsigned long long s;
        acpi_status status;

        status = acpi_evaluate_integer(device->handle, METHOD_HKEY_SQTY,
                                       NULL, &s);
        if (ACPI_SUCCESS(status))
                return s;
        else {
                pr_err("evaluation error HKEY.SQTY\n");
                return -EINVAL;
        }
}

static int acpi_pcc_retrieve_biosdata(struct pcc_acpi *pcc)
{
        acpi_status status;
        struct acpi_buffer buffer = {ACPI_ALLOCATE_BUFFER, NULL};
        union acpi_object *hkey = NULL;
        int i;

        status = acpi_evaluate_object(pcc->handle, METHOD_HKEY_SINF, NULL,
                                      &buffer);
        if (ACPI_FAILURE(status)) {
                pr_err("evaluation error HKEY.SINF\n");
                return 0;
        }

        hkey = buffer.pointer;
        if (!hkey || (hkey->type != ACPI_TYPE_PACKAGE)) {
                pr_err("Invalid HKEY.SINF\n");
                status = AE_ERROR;
                goto end;
        }

        if (pcc->num_sifr < hkey->package.count) {
                pr_err("SQTY reports bad SINF length SQTY: %lu SINF-pkg-count: %u\n",
                       pcc->num_sifr, hkey->package.count);
                status = AE_ERROR;
                goto end;
        }

        for (i = 0; i < hkey->package.count; i++) {
                union acpi_object *element = &(hkey->package.elements[i]);
                if (likely(element->type == ACPI_TYPE_INTEGER)) {
                        pcc->sinf[i] = element->integer.value;
                } else
                        pr_err("Invalid HKEY.SINF data\n");
        }
        pcc->sinf[hkey->package.count] = -1;

end:
        kfree(buffer.pointer);
        return status == AE_OK;
}

/* backlight API interface functions */

/* This driver currently treats AC and DC brightness identical,
 * since we don't need to invent an interface to the core ACPI
 * logic to receive events in case a power supply is plugged in
 * or removed */

static int bl_get(struct backlight_device *bd)
{
        struct pcc_acpi *pcc = bl_get_data(bd);

        if (!acpi_pcc_retrieve_biosdata(pcc))
                return -EIO;

        return pcc->sinf[SINF_AC_CUR_BRIGHT];
}

static int bl_set_status(struct backlight_device *bd)
{
        struct pcc_acpi *pcc = bl_get_data(bd);
        int bright = bd->props.brightness;
        int rc;

        if (!acpi_pcc_retrieve_biosdata(pcc))
                return -EIO;

        if (bright < pcc->sinf[SINF_AC_MIN_BRIGHT])
                bright = pcc->sinf[SINF_AC_MIN_BRIGHT];

        if (bright < pcc->sinf[SINF_DC_MIN_BRIGHT])
                bright = pcc->sinf[SINF_DC_MIN_BRIGHT];

        if (bright < pcc->sinf[SINF_AC_MIN_BRIGHT] ||
            bright > pcc->sinf[SINF_AC_MAX_BRIGHT])
                return -EINVAL;

        rc = acpi_pcc_write_sset(pcc, SINF_AC_CUR_BRIGHT, bright);
        if (rc < 0)
                return rc;

        return acpi_pcc_write_sset(pcc, SINF_DC_CUR_BRIGHT, bright);
}

static const struct backlight_ops pcc_backlight_ops = {
        .get_brightness = bl_get,
        .update_status  = bl_set_status,
};


/* returns ACPI_SUCCESS if methods to control optical drive are present */

static acpi_status check_optd_present(void)
{
        acpi_status status = AE_OK;
        acpi_handle handle;

        status = acpi_get_handle(NULL, "\\_SB.STAT", &handle);
        if (ACPI_FAILURE(status))
                goto out;
        status = acpi_get_handle(NULL, "\\_SB.FBAY", &handle);
        if (ACPI_FAILURE(status))
                goto out;
        status = acpi_get_handle(NULL, "\\_SB.CDDI", &handle);
        if (ACPI_FAILURE(status))
                goto out;

out:
        return status;
}

/* get optical driver power state */

static int get_optd_power_state(void)
{
        acpi_status status;
        unsigned long long state;
        int result;

        status = acpi_evaluate_integer(NULL, "\\_SB.STAT", NULL, &state);
        if (ACPI_FAILURE(status)) {
                pr_err("evaluation error _SB.STAT\n");
                result = -EIO;
                goto out;
        }
        switch (state) {
        case 0: /* power off */
                result = 0;
                break;
        case 0x0f: /* power on */
                result = 1;
                break;
        default:
                result = -EIO;
                break;
        }

out:
        return result;
}

/* set optical drive power state */

static int set_optd_power_state(int new_state)
{
        int result;
        acpi_status status;

        result = get_optd_power_state();
        if (result < 0)
                goto out;
        if (new_state == result)
                goto out;

        switch (new_state) {
        case 0: /* power off */
                /* Call CDDR instead, since they both call the same method
                 * while CDDI takes 1 arg and we are not quite sure what it is.
                 */
                status = acpi_evaluate_object(NULL, "\\_SB.CDDR", NULL, NULL);
                if (ACPI_FAILURE(status)) {
                        pr_err("evaluation error _SB.CDDR\n");
                        result = -EIO;
                }
                break;
        case 1: /* power on */
                status = acpi_evaluate_object(NULL, "\\_SB.FBAY", NULL, NULL);
                if (ACPI_FAILURE(status)) {
                        pr_err("evaluation error _SB.FBAY\n");
                        result = -EIO;
                }
                break;
        default:
                result = -EINVAL;
                break;
        }

out:
        return result;
}


/* sysfs user interface functions */

static ssize_t numbatt_show(struct device *dev, struct device_attribute *attr,
                            char *buf)
{
        struct acpi_device *acpi = to_acpi_device(dev);
        struct pcc_acpi *pcc = acpi_driver_data(acpi);

        if (!acpi_pcc_retrieve_biosdata(pcc))
                return -EIO;

        return sysfs_emit(buf, "%u\n", pcc->sinf[SINF_NUM_BATTERIES]);
}

static ssize_t lcdtype_show(struct device *dev, struct device_attribute *attr,
                            char *buf)
{
        struct acpi_device *acpi = to_acpi_device(dev);
        struct pcc_acpi *pcc = acpi_driver_data(acpi);

        if (!acpi_pcc_retrieve_biosdata(pcc))
                return -EIO;

        return sysfs_emit(buf, "%u\n", pcc->sinf[SINF_LCD_TYPE]);
}

static ssize_t mute_show(struct device *dev, struct device_attribute *attr,
                         char *buf)
{
        struct acpi_device *acpi = to_acpi_device(dev);
        struct pcc_acpi *pcc = acpi_driver_data(acpi);

        if (!acpi_pcc_retrieve_biosdata(pcc))
                return -EIO;

        return sysfs_emit(buf, "%u\n", pcc->sinf[SINF_MUTE]);
}

static ssize_t mute_store(struct device *dev, struct device_attribute *attr,
                          const char *buf, size_t count)
{
        struct acpi_device *acpi = to_acpi_device(dev);
        struct pcc_acpi *pcc = acpi_driver_data(acpi);
        int err, val;

        err = kstrtoint(buf, 0, &val);
        if (err)
                return err;
        if (val == 0 || val == 1) {
                acpi_pcc_write_sset(pcc, SINF_MUTE, val);
                pcc->mute = val;
        }

        return count;
}

static ssize_t sticky_key_show(struct device *dev, struct device_attribute *attr,
                           char *buf)
{
        struct acpi_device *acpi = to_acpi_device(dev);
        struct pcc_acpi *pcc = acpi_driver_data(acpi);

        if (!acpi_pcc_retrieve_biosdata(pcc))
                return -EIO;

        return sysfs_emit(buf, "%u\n", pcc->sticky_key);
}

static ssize_t sticky_key_store(struct device *dev, struct device_attribute *attr,
                          const char *buf, size_t count)
{
        struct acpi_device *acpi = to_acpi_device(dev);
        struct pcc_acpi *pcc = acpi_driver_data(acpi);
        int err, val;

        err = kstrtoint(buf, 0, &val);
        if (err)
                return err;
        if (val == 0 || val == 1) {
                acpi_pcc_write_sset(pcc, SINF_STICKY_KEY, val);
                pcc->sticky_key = val;
        }

        return count;
}

static ssize_t eco_mode_show(struct device *dev, struct device_attribute *attr,
                                char *buf)
{
        struct acpi_device *acpi = to_acpi_device(dev);
        struct pcc_acpi *pcc = acpi_driver_data(acpi);
        int result;

        if (!acpi_pcc_retrieve_biosdata(pcc))
                return -EIO;

        switch (pcc->sinf[SINF_ECO_MODE]) {
        case (ECO_MODE_OFF + 3):
                result = 0;
                break;
        case (ECO_MODE_ON + 3):
                result = 1;
                break;
        default:
                return -EIO;
        }
        return sysfs_emit(buf, "%u\n", result);
}

static ssize_t eco_mode_store(struct device *dev, struct device_attribute *attr,
                          const char *buf, size_t count)
{
        struct acpi_device *acpi = to_acpi_device(dev);
        struct pcc_acpi *pcc = acpi_driver_data(acpi);
        int err, state;

        union acpi_object param[2];
        struct acpi_object_list input;
        acpi_status status;

        param[0].type = ACPI_TYPE_INTEGER;
        param[0].integer.value = 0x15;
        param[1].type = ACPI_TYPE_INTEGER;
        input.count = 2;
        input.pointer = param;

        err = kstrtoint(buf, 0, &state);
        if (err)
                return err;

        switch (state) {
        case 0:
                param[1].integer.value = ECO_MODE_OFF;
                pcc->sinf[SINF_ECO_MODE] = 0;
                pcc->eco_mode = 0;
                break;
        case 1:
                param[1].integer.value = ECO_MODE_ON;
                pcc->sinf[SINF_ECO_MODE] = 1;
                pcc->eco_mode = 1;
                break;
        default:
                /* nothing to do */
                return count;
        }

        status = acpi_evaluate_object(NULL, METHOD_ECWR,
                                       &input, NULL);
        if (ACPI_FAILURE(status)) {
                pr_err("%s evaluation failed\n", METHOD_ECWR);
                return -EINVAL;
        }

        return count;
}

static ssize_t ac_brightness_show(struct device *dev, struct device_attribute *attr,
                                  char *buf)
{
        struct acpi_device *acpi = to_acpi_device(dev);
        struct pcc_acpi *pcc = acpi_driver_data(acpi);

        if (!acpi_pcc_retrieve_biosdata(pcc))
                return -EIO;

        return sysfs_emit(buf, "%u\n", pcc->sinf[SINF_AC_CUR_BRIGHT]);
}

static ssize_t ac_brightness_store(struct device *dev, struct device_attribute *attr,
                                   const char *buf, size_t count)
{
        struct acpi_device *acpi = to_acpi_device(dev);
        struct pcc_acpi *pcc = acpi_driver_data(acpi);
        int err, val;

        err = kstrtoint(buf, 0, &val);
        if (err)
                return err;
        if (val >= 0 && val <= 255) {
                acpi_pcc_write_sset(pcc, SINF_AC_CUR_BRIGHT, val);
                pcc->ac_brightness = val;
        }

        return count;
}

static ssize_t dc_brightness_show(struct device *dev, struct device_attribute *attr,
                                  char *buf)
{
        struct acpi_device *acpi = to_acpi_device(dev);
        struct pcc_acpi *pcc = acpi_driver_data(acpi);

        if (!acpi_pcc_retrieve_biosdata(pcc))
                return -EIO;

        return sysfs_emit(buf, "%u\n", pcc->sinf[SINF_DC_CUR_BRIGHT]);
}

static ssize_t dc_brightness_store(struct device *dev, struct device_attribute *attr,
                                   const char *buf, size_t count)
{
        struct acpi_device *acpi = to_acpi_device(dev);
        struct pcc_acpi *pcc = acpi_driver_data(acpi);
        int err, val;

        err = kstrtoint(buf, 0, &val);
        if (err)
                return err;
        if (val >= 0 && val <= 255) {
                acpi_pcc_write_sset(pcc, SINF_DC_CUR_BRIGHT, val);
                pcc->dc_brightness = val;
        }

        return count;
}

static ssize_t current_brightness_show(struct device *dev, struct device_attribute *attr,
                                       char *buf)
{
        struct acpi_device *acpi = to_acpi_device(dev);
        struct pcc_acpi *pcc = acpi_driver_data(acpi);

        if (!acpi_pcc_retrieve_biosdata(pcc))
                return -EIO;

        return sysfs_emit(buf, "%u\n", pcc->sinf[SINF_CUR_BRIGHT]);
}

static ssize_t current_brightness_store(struct device *dev, struct device_attribute *attr,
                                        const char *buf, size_t count)
{
        struct acpi_device *acpi = to_acpi_device(dev);
        struct pcc_acpi *pcc = acpi_driver_data(acpi);
        int err, val;

        err = kstrtoint(buf, 0, &val);
        if (err)
                return err;

        if (val >= 0 && val <= 255) {
                err = acpi_pcc_write_sset(pcc, SINF_CUR_BRIGHT, val);
                pcc->current_brightness = val;
        }

        return count;
}

static ssize_t cdpower_show(struct device *dev, struct device_attribute *attr,
                            char *buf)
{
        int state = get_optd_power_state();

        if (state < 0)
                return state;

        return sysfs_emit(buf, "%d\n", state);
}

static ssize_t cdpower_store(struct device *dev, struct device_attribute *attr,
                           const char *buf, size_t count)
{
        int err, val;

        err = kstrtoint(buf, 10, &val);
        if (err)
                return err;
        set_optd_power_state(val);
        return count;
}

static DEVICE_ATTR_RO(numbatt);
static DEVICE_ATTR_RO(lcdtype);
static DEVICE_ATTR_RW(mute);
static DEVICE_ATTR_RW(sticky_key);
static DEVICE_ATTR_RW(eco_mode);
static DEVICE_ATTR_RW(ac_brightness);
static DEVICE_ATTR_RW(dc_brightness);
static DEVICE_ATTR_RW(current_brightness);
static DEVICE_ATTR_RW(cdpower);

static umode_t pcc_sysfs_is_visible(struct kobject *kobj, struct attribute *attr, int idx)
{
        struct device *dev = kobj_to_dev(kobj);
        struct acpi_device *acpi = to_acpi_device(dev);
        struct pcc_acpi *pcc = acpi_driver_data(acpi);

        if (attr == &dev_attr_mute.attr)
                return (pcc->num_sifr > SINF_MUTE) ? attr->mode : 0;

        if (attr == &dev_attr_eco_mode.attr)
                return (pcc->num_sifr > SINF_ECO_MODE) ? attr->mode : 0;

        if (attr == &dev_attr_current_brightness.attr)
                return (pcc->num_sifr > SINF_CUR_BRIGHT) ? attr->mode : 0;

        return attr->mode;
}

static struct attribute *pcc_sysfs_entries[] = {
        &dev_attr_numbatt.attr,
        &dev_attr_lcdtype.attr,
        &dev_attr_mute.attr,
        &dev_attr_sticky_key.attr,
        &dev_attr_eco_mode.attr,
        &dev_attr_ac_brightness.attr,
        &dev_attr_dc_brightness.attr,
        &dev_attr_current_brightness.attr,
        &dev_attr_cdpower.attr,
        NULL,
};

static const struct attribute_group pcc_attr_group = {
        .name           = NULL,         /* put in device directory */
        .attrs          = pcc_sysfs_entries,
        .is_visible     = pcc_sysfs_is_visible,
};


/* hotkey input device driver */

static int sleep_keydown_seen;
static void acpi_pcc_generate_keyinput(struct pcc_acpi *pcc)
{
        struct input_dev *hotk_input_dev = pcc->input_dev;
        int rc;
        unsigned long long result;
        unsigned int key;
        unsigned int updown;

        rc = acpi_evaluate_integer(pcc->handle, METHOD_HKEY_QUERY,
                                   NULL, &result);
        if (ACPI_FAILURE(rc)) {
                pr_err("error getting hotkey status\n");
                return;
        }

        key = result & GENMASK(6, 0);
        updown = result & BIT(7); /* 0x80 == key down; 0x00 = key up */

        /* hack: some firmware sends no key down for sleep / hibernate */
        if (key == 7 || key == 10) {
                if (updown)
                        sleep_keydown_seen = 1;
                if (!sleep_keydown_seen)
                        sparse_keymap_report_event(hotk_input_dev,
                                        key, 0x80, false);
        }

        /*
         * Don't report brightness key-presses if they are also reported
         * by the ACPI video bus.
         */
        if ((key == 1 || key == 2) && acpi_video_handles_brightness_key_presses())
                return;

        if (!sparse_keymap_report_event(hotk_input_dev, key, updown, false))
                pr_err("Unknown hotkey event: 0x%04llx\n", result);
}

static void acpi_pcc_hotkey_notify(struct acpi_device *device, u32 event)
{
        struct pcc_acpi *pcc = acpi_driver_data(device);

        switch (event) {
        case HKEY_NOTIFY:
                acpi_pcc_generate_keyinput(pcc);
                break;
        default:
                /* nothing to do */
                break;
        }
}

static void pcc_optd_notify(acpi_handle handle, u32 event, void *data)
{
        if (event != ACPI_NOTIFY_EJECT_REQUEST)
                return;

        set_optd_power_state(0);
}

static int pcc_register_optd_notifier(struct pcc_acpi *pcc, char *node)
{
        acpi_status status;
        acpi_handle handle;

        status = acpi_get_handle(NULL, node, &handle);

        if (ACPI_SUCCESS(status)) {
                status = acpi_install_notify_handler(handle,
                                ACPI_SYSTEM_NOTIFY,
                                pcc_optd_notify, pcc);
                if (ACPI_FAILURE(status))
                        pr_err("Failed to register notify on %s\n", node);
        } else
                return -ENODEV;

        return 0;
}

static void pcc_unregister_optd_notifier(struct pcc_acpi *pcc, char *node)
{
        acpi_status status = AE_OK;
        acpi_handle handle;

        status = acpi_get_handle(NULL, node, &handle);

        if (ACPI_SUCCESS(status)) {
                status = acpi_remove_notify_handler(handle,
                                ACPI_SYSTEM_NOTIFY,
                                pcc_optd_notify);
                if (ACPI_FAILURE(status))
                        pr_err("Error removing optd notify handler %s\n",
                                        node);
        }
}

static int acpi_pcc_init_input(struct pcc_acpi *pcc)
{
        struct input_dev *input_dev;
        int error;

        input_dev = input_allocate_device();
        if (!input_dev)
                return -ENOMEM;

        input_dev->name = ACPI_PCC_DRIVER_NAME;
        input_dev->phys = ACPI_PCC_INPUT_PHYS;
        input_dev->id.bustype = BUS_HOST;
        input_dev->id.vendor = 0x0001;
        input_dev->id.product = 0x0001;
        input_dev->id.version = 0x0100;

        error = sparse_keymap_setup(input_dev, panasonic_keymap, NULL);
        if (error) {
                pr_err("Unable to setup input device keymap\n");
                goto err_free_dev;
        }

        error = input_register_device(input_dev);
        if (error) {
                pr_err("Unable to register input device\n");
                goto err_free_dev;
        }

        pcc->input_dev = input_dev;
        return 0;

 err_free_dev:
        input_free_device(input_dev);
        return error;
}

/* kernel module interface */

#ifdef CONFIG_PM_SLEEP
static int acpi_pcc_hotkey_resume(struct device *dev)
{
        struct pcc_acpi *pcc;

        if (!dev)
                return -EINVAL;

        pcc = acpi_driver_data(to_acpi_device(dev));
        if (!pcc)
                return -EINVAL;

        if (pcc->num_sifr > SINF_MUTE)
                acpi_pcc_write_sset(pcc, SINF_MUTE, pcc->mute);
        if (pcc->num_sifr > SINF_ECO_MODE)
                acpi_pcc_write_sset(pcc, SINF_ECO_MODE, pcc->eco_mode);
        acpi_pcc_write_sset(pcc, SINF_STICKY_KEY, pcc->sticky_key);
        acpi_pcc_write_sset(pcc, SINF_AC_CUR_BRIGHT, pcc->ac_brightness);
        acpi_pcc_write_sset(pcc, SINF_DC_CUR_BRIGHT, pcc->dc_brightness);
        if (pcc->num_sifr > SINF_CUR_BRIGHT)
                acpi_pcc_write_sset(pcc, SINF_CUR_BRIGHT, pcc->current_brightness);

        return 0;
}
#endif

static int acpi_pcc_hotkey_add(struct acpi_device *device)
{
        struct backlight_properties props;
        struct pcc_acpi *pcc;
        int num_sifr, result;

        if (!device)
                return -EINVAL;

        num_sifr = acpi_pcc_get_sqty(device);

        /*
         * pcc->sinf is expected to at least have the AC+DC brightness entries.
         * Accesses to higher SINF entries are checked against num_sifr.
         */
        if (num_sifr <= SINF_DC_CUR_BRIGHT || num_sifr > 255) {
                pr_err("num_sifr %d out of range %d - 255\n", num_sifr, SINF_DC_CUR_BRIGHT + 1);
                return -ENODEV;
        }

        /*
         * Some DSDT-s have an off-by-one bug where the SINF package count is
         * one higher than the SQTY reported value, allocate 1 entry extra.
         */
        num_sifr++;

        pcc = kzalloc_obj(struct pcc_acpi);
        if (!pcc) {
                pr_err("Couldn't allocate mem for pcc");
                return -ENOMEM;
        }

        pcc->sinf = kcalloc(num_sifr + 1, sizeof(u32), GFP_KERNEL);
        if (!pcc->sinf) {
                result = -ENOMEM;
                goto out_hotkey;
        }

        pcc->device = device;
        pcc->handle = device->handle;
        pcc->num_sifr = num_sifr;
        device->driver_data = pcc;
        strscpy(acpi_device_name(device), ACPI_PCC_DEVICE_NAME);
        strscpy(acpi_device_class(device), ACPI_PCC_CLASS);

        result = acpi_pcc_init_input(pcc);
        if (result) {
                pr_err("Error installing keyinput handler\n");
                goto out_sinf;
        }

        if (!acpi_pcc_retrieve_biosdata(pcc)) {
                result = -EIO;
                pr_err("Couldn't retrieve BIOS data\n");
                goto out_input;
        }

        if (acpi_video_get_backlight_type() == acpi_backlight_vendor) {
                /* initialize backlight */
                memset(&props, 0, sizeof(struct backlight_properties));
                props.type = BACKLIGHT_PLATFORM;
                props.max_brightness = pcc->sinf[SINF_AC_MAX_BRIGHT];

                pcc->backlight = backlight_device_register("panasonic", NULL, pcc,
                                                           &pcc_backlight_ops, &props);
                if (IS_ERR(pcc->backlight)) {
                        result = PTR_ERR(pcc->backlight);
                        goto out_input;
                }

                /* read the initial brightness setting from the hardware */
                pcc->backlight->props.brightness = pcc->sinf[SINF_AC_CUR_BRIGHT];
        }

        /* Reset initial sticky key mode since the hardware register state is not consistent */
        acpi_pcc_write_sset(pcc, SINF_STICKY_KEY, 0);
        pcc->sticky_key = 0;

        pcc->ac_brightness = pcc->sinf[SINF_AC_CUR_BRIGHT];
        pcc->dc_brightness = pcc->sinf[SINF_DC_CUR_BRIGHT];
        if (pcc->num_sifr > SINF_MUTE)
                pcc->mute = pcc->sinf[SINF_MUTE];
        if (pcc->num_sifr > SINF_ECO_MODE)
                pcc->eco_mode = pcc->sinf[SINF_ECO_MODE];
        if (pcc->num_sifr > SINF_CUR_BRIGHT)
                pcc->current_brightness = pcc->sinf[SINF_CUR_BRIGHT];

        /* add sysfs attributes */
        result = sysfs_create_group(&device->dev.kobj, &pcc_attr_group);
        if (result)
                goto out_backlight;

        /* optical drive initialization */
        if (ACPI_SUCCESS(check_optd_present())) {
                pcc->platform = platform_device_register_simple("panasonic",
                        PLATFORM_DEVID_NONE, NULL, 0);
                if (IS_ERR(pcc->platform)) {
                        result = PTR_ERR(pcc->platform);
                        goto out_sysfs;
                }
                result = device_create_file(&pcc->platform->dev,
                        &dev_attr_cdpower);
                pcc_register_optd_notifier(pcc, "\\_SB.PCI0.EHCI.ERHB.OPTD");
                if (result)
                        goto out_platform;
        } else {
                pcc->platform = NULL;
        }

        i8042_install_filter(panasonic_i8042_filter, NULL);
        return 0;

out_platform:
        platform_device_unregister(pcc->platform);
out_sysfs:
        sysfs_remove_group(&device->dev.kobj, &pcc_attr_group);
out_backlight:
        backlight_device_unregister(pcc->backlight);
out_input:
        input_unregister_device(pcc->input_dev);
out_sinf:
        kfree(pcc->sinf);
out_hotkey:
        kfree(pcc);

        return result;
}

static void acpi_pcc_hotkey_remove(struct acpi_device *device)
{
        struct pcc_acpi *pcc = acpi_driver_data(device);

        if (!device || !pcc)
                return;

        i8042_remove_filter(panasonic_i8042_filter);

        if (pcc->platform) {
                device_remove_file(&pcc->platform->dev, &dev_attr_cdpower);
                platform_device_unregister(pcc->platform);
        }
        pcc_unregister_optd_notifier(pcc, "\\_SB.PCI0.EHCI.ERHB.OPTD");

        sysfs_remove_group(&device->dev.kobj, &pcc_attr_group);

        backlight_device_unregister(pcc->backlight);

        input_unregister_device(pcc->input_dev);

        kfree(pcc->sinf);
        kfree(pcc);
}

module_acpi_driver(acpi_pcc_driver);