1d2912cb1SThomas Gleixner // SPDX-License-Identifier: GPL-2.0-only 2062589b1SGabriel FERNANDEZ /* 3062589b1SGabriel FERNANDEZ * STMicroelectronics Key Scanning driver 4062589b1SGabriel FERNANDEZ * 5062589b1SGabriel FERNANDEZ * Copyright (c) 2014 STMicroelectonics Ltd. 6062589b1SGabriel FERNANDEZ * Author: Stuart Menefy <stuart.menefy@st.com> 7062589b1SGabriel FERNANDEZ * 8062589b1SGabriel FERNANDEZ * Based on sh_keysc.c, copyright 2008 Magnus Damm 9062589b1SGabriel FERNANDEZ */ 10062589b1SGabriel FERNANDEZ 11062589b1SGabriel FERNANDEZ #include <linux/module.h> 12062589b1SGabriel FERNANDEZ #include <linux/interrupt.h> 13062589b1SGabriel FERNANDEZ #include <linux/platform_device.h> 14062589b1SGabriel FERNANDEZ #include <linux/clk.h> 15062589b1SGabriel FERNANDEZ #include <linux/io.h> 16062589b1SGabriel FERNANDEZ #include <linux/input/matrix_keypad.h> 17062589b1SGabriel FERNANDEZ 18062589b1SGabriel FERNANDEZ #define ST_KEYSCAN_MAXKEYS 16 19062589b1SGabriel FERNANDEZ 20062589b1SGabriel FERNANDEZ #define KEYSCAN_CONFIG_OFF 0x0 21062589b1SGabriel FERNANDEZ #define KEYSCAN_CONFIG_ENABLE 0x1 22062589b1SGabriel FERNANDEZ #define KEYSCAN_DEBOUNCE_TIME_OFF 0x4 23062589b1SGabriel FERNANDEZ #define KEYSCAN_MATRIX_STATE_OFF 0x8 24062589b1SGabriel FERNANDEZ #define KEYSCAN_MATRIX_DIM_OFF 0xc 25062589b1SGabriel FERNANDEZ #define KEYSCAN_MATRIX_DIM_X_SHIFT 0x0 26062589b1SGabriel FERNANDEZ #define KEYSCAN_MATRIX_DIM_Y_SHIFT 0x2 27062589b1SGabriel FERNANDEZ 28062589b1SGabriel FERNANDEZ struct st_keyscan { 29062589b1SGabriel FERNANDEZ void __iomem *base; 30062589b1SGabriel FERNANDEZ int irq; 31062589b1SGabriel FERNANDEZ struct clk *clk; 32062589b1SGabriel FERNANDEZ struct input_dev *input_dev; 33062589b1SGabriel FERNANDEZ unsigned long last_state; 34062589b1SGabriel FERNANDEZ unsigned int n_rows; 35062589b1SGabriel FERNANDEZ unsigned int n_cols; 36062589b1SGabriel FERNANDEZ unsigned int debounce_us; 37062589b1SGabriel FERNANDEZ }; 38062589b1SGabriel FERNANDEZ 39062589b1SGabriel FERNANDEZ static irqreturn_t keyscan_isr(int irq, void *dev_id) 40062589b1SGabriel FERNANDEZ { 41062589b1SGabriel FERNANDEZ struct st_keyscan *keypad = dev_id; 42062589b1SGabriel FERNANDEZ unsigned short *keycode = keypad->input_dev->keycode; 43062589b1SGabriel FERNANDEZ unsigned long state, change; 44062589b1SGabriel FERNANDEZ int bit_nr; 45062589b1SGabriel FERNANDEZ 46062589b1SGabriel FERNANDEZ state = readl(keypad->base + KEYSCAN_MATRIX_STATE_OFF) & 0xffff; 47062589b1SGabriel FERNANDEZ change = keypad->last_state ^ state; 48062589b1SGabriel FERNANDEZ keypad->last_state = state; 49062589b1SGabriel FERNANDEZ 50062589b1SGabriel FERNANDEZ for_each_set_bit(bit_nr, &change, BITS_PER_LONG) 51062589b1SGabriel FERNANDEZ input_report_key(keypad->input_dev, 52062589b1SGabriel FERNANDEZ keycode[bit_nr], state & BIT(bit_nr)); 53062589b1SGabriel FERNANDEZ 54062589b1SGabriel FERNANDEZ input_sync(keypad->input_dev); 55062589b1SGabriel FERNANDEZ 56062589b1SGabriel FERNANDEZ return IRQ_HANDLED; 57062589b1SGabriel FERNANDEZ } 58062589b1SGabriel FERNANDEZ 59062589b1SGabriel FERNANDEZ static int keyscan_start(struct st_keyscan *keypad) 60062589b1SGabriel FERNANDEZ { 61062589b1SGabriel FERNANDEZ int error; 62062589b1SGabriel FERNANDEZ 63062589b1SGabriel FERNANDEZ error = clk_enable(keypad->clk); 64062589b1SGabriel FERNANDEZ if (error) 65062589b1SGabriel FERNANDEZ return error; 66062589b1SGabriel FERNANDEZ 67062589b1SGabriel FERNANDEZ writel(keypad->debounce_us * (clk_get_rate(keypad->clk) / 1000000), 68062589b1SGabriel FERNANDEZ keypad->base + KEYSCAN_DEBOUNCE_TIME_OFF); 69062589b1SGabriel FERNANDEZ 70062589b1SGabriel FERNANDEZ writel(((keypad->n_cols - 1) << KEYSCAN_MATRIX_DIM_X_SHIFT) | 71062589b1SGabriel FERNANDEZ ((keypad->n_rows - 1) << KEYSCAN_MATRIX_DIM_Y_SHIFT), 72062589b1SGabriel FERNANDEZ keypad->base + KEYSCAN_MATRIX_DIM_OFF); 73062589b1SGabriel FERNANDEZ 74062589b1SGabriel FERNANDEZ writel(KEYSCAN_CONFIG_ENABLE, keypad->base + KEYSCAN_CONFIG_OFF); 75062589b1SGabriel FERNANDEZ 76062589b1SGabriel FERNANDEZ return 0; 77062589b1SGabriel FERNANDEZ } 78062589b1SGabriel FERNANDEZ 79062589b1SGabriel FERNANDEZ static void keyscan_stop(struct st_keyscan *keypad) 80062589b1SGabriel FERNANDEZ { 81062589b1SGabriel FERNANDEZ writel(0, keypad->base + KEYSCAN_CONFIG_OFF); 82062589b1SGabriel FERNANDEZ 83062589b1SGabriel FERNANDEZ clk_disable(keypad->clk); 84062589b1SGabriel FERNANDEZ } 85062589b1SGabriel FERNANDEZ 86062589b1SGabriel FERNANDEZ static int keyscan_open(struct input_dev *dev) 87062589b1SGabriel FERNANDEZ { 88062589b1SGabriel FERNANDEZ struct st_keyscan *keypad = input_get_drvdata(dev); 89062589b1SGabriel FERNANDEZ 90062589b1SGabriel FERNANDEZ return keyscan_start(keypad); 91062589b1SGabriel FERNANDEZ } 92062589b1SGabriel FERNANDEZ 93062589b1SGabriel FERNANDEZ static void keyscan_close(struct input_dev *dev) 94062589b1SGabriel FERNANDEZ { 95062589b1SGabriel FERNANDEZ struct st_keyscan *keypad = input_get_drvdata(dev); 96062589b1SGabriel FERNANDEZ 97062589b1SGabriel FERNANDEZ keyscan_stop(keypad); 98062589b1SGabriel FERNANDEZ } 99062589b1SGabriel FERNANDEZ 100062589b1SGabriel FERNANDEZ static int keypad_matrix_key_parse_dt(struct st_keyscan *keypad_data) 101062589b1SGabriel FERNANDEZ { 102062589b1SGabriel FERNANDEZ struct device *dev = keypad_data->input_dev->dev.parent; 103062589b1SGabriel FERNANDEZ struct device_node *np = dev->of_node; 104062589b1SGabriel FERNANDEZ int error; 105062589b1SGabriel FERNANDEZ 106aef01aadSDmitry Torokhov error = matrix_keypad_parse_properties(dev, &keypad_data->n_rows, 107062589b1SGabriel FERNANDEZ &keypad_data->n_cols); 108062589b1SGabriel FERNANDEZ if (error) { 109062589b1SGabriel FERNANDEZ dev_err(dev, "failed to parse keypad params\n"); 110062589b1SGabriel FERNANDEZ return error; 111062589b1SGabriel FERNANDEZ } 112062589b1SGabriel FERNANDEZ 113062589b1SGabriel FERNANDEZ of_property_read_u32(np, "st,debounce-us", &keypad_data->debounce_us); 114062589b1SGabriel FERNANDEZ 115062589b1SGabriel FERNANDEZ dev_dbg(dev, "n_rows=%d n_col=%d debounce=%d\n", 116062589b1SGabriel FERNANDEZ keypad_data->n_rows, keypad_data->n_cols, 117062589b1SGabriel FERNANDEZ keypad_data->debounce_us); 118062589b1SGabriel FERNANDEZ 119062589b1SGabriel FERNANDEZ return 0; 120062589b1SGabriel FERNANDEZ } 121062589b1SGabriel FERNANDEZ 122062589b1SGabriel FERNANDEZ static int keyscan_probe(struct platform_device *pdev) 123062589b1SGabriel FERNANDEZ { 124062589b1SGabriel FERNANDEZ struct st_keyscan *keypad_data; 125062589b1SGabriel FERNANDEZ struct input_dev *input_dev; 126062589b1SGabriel FERNANDEZ struct resource *res; 127062589b1SGabriel FERNANDEZ int error; 128062589b1SGabriel FERNANDEZ 129062589b1SGabriel FERNANDEZ if (!pdev->dev.of_node) { 130062589b1SGabriel FERNANDEZ dev_err(&pdev->dev, "no DT data present\n"); 131062589b1SGabriel FERNANDEZ return -EINVAL; 132062589b1SGabriel FERNANDEZ } 133062589b1SGabriel FERNANDEZ 134062589b1SGabriel FERNANDEZ keypad_data = devm_kzalloc(&pdev->dev, sizeof(*keypad_data), 135062589b1SGabriel FERNANDEZ GFP_KERNEL); 136062589b1SGabriel FERNANDEZ if (!keypad_data) 137062589b1SGabriel FERNANDEZ return -ENOMEM; 138062589b1SGabriel FERNANDEZ 139062589b1SGabriel FERNANDEZ input_dev = devm_input_allocate_device(&pdev->dev); 140062589b1SGabriel FERNANDEZ if (!input_dev) { 141062589b1SGabriel FERNANDEZ dev_err(&pdev->dev, "failed to allocate the input device\n"); 142062589b1SGabriel FERNANDEZ return -ENOMEM; 143062589b1SGabriel FERNANDEZ } 144062589b1SGabriel FERNANDEZ 145062589b1SGabriel FERNANDEZ input_dev->name = pdev->name; 146062589b1SGabriel FERNANDEZ input_dev->phys = "keyscan-keys/input0"; 147062589b1SGabriel FERNANDEZ input_dev->dev.parent = &pdev->dev; 148062589b1SGabriel FERNANDEZ input_dev->open = keyscan_open; 149062589b1SGabriel FERNANDEZ input_dev->close = keyscan_close; 150062589b1SGabriel FERNANDEZ 151062589b1SGabriel FERNANDEZ input_dev->id.bustype = BUS_HOST; 152062589b1SGabriel FERNANDEZ 1532439d37eSGabriel Fernandez keypad_data->input_dev = input_dev; 1542439d37eSGabriel Fernandez 155062589b1SGabriel FERNANDEZ error = keypad_matrix_key_parse_dt(keypad_data); 156062589b1SGabriel FERNANDEZ if (error) 157062589b1SGabriel FERNANDEZ return error; 158062589b1SGabriel FERNANDEZ 159062589b1SGabriel FERNANDEZ error = matrix_keypad_build_keymap(NULL, NULL, 160062589b1SGabriel FERNANDEZ keypad_data->n_rows, 161062589b1SGabriel FERNANDEZ keypad_data->n_cols, 162062589b1SGabriel FERNANDEZ NULL, input_dev); 163062589b1SGabriel FERNANDEZ if (error) { 164062589b1SGabriel FERNANDEZ dev_err(&pdev->dev, "failed to build keymap\n"); 165062589b1SGabriel FERNANDEZ return error; 166062589b1SGabriel FERNANDEZ } 167062589b1SGabriel FERNANDEZ 168062589b1SGabriel FERNANDEZ input_set_drvdata(input_dev, keypad_data); 169062589b1SGabriel FERNANDEZ 170062589b1SGabriel FERNANDEZ res = platform_get_resource(pdev, IORESOURCE_MEM, 0); 171062589b1SGabriel FERNANDEZ keypad_data->base = devm_ioremap_resource(&pdev->dev, res); 172062589b1SGabriel FERNANDEZ if (IS_ERR(keypad_data->base)) 173062589b1SGabriel FERNANDEZ return PTR_ERR(keypad_data->base); 174062589b1SGabriel FERNANDEZ 175062589b1SGabriel FERNANDEZ keypad_data->clk = devm_clk_get(&pdev->dev, NULL); 176062589b1SGabriel FERNANDEZ if (IS_ERR(keypad_data->clk)) { 177062589b1SGabriel FERNANDEZ dev_err(&pdev->dev, "cannot get clock\n"); 178062589b1SGabriel FERNANDEZ return PTR_ERR(keypad_data->clk); 179062589b1SGabriel FERNANDEZ } 180062589b1SGabriel FERNANDEZ 181062589b1SGabriel FERNANDEZ error = clk_enable(keypad_data->clk); 182062589b1SGabriel FERNANDEZ if (error) { 183062589b1SGabriel FERNANDEZ dev_err(&pdev->dev, "failed to enable clock\n"); 184062589b1SGabriel FERNANDEZ return error; 185062589b1SGabriel FERNANDEZ } 186062589b1SGabriel FERNANDEZ 187062589b1SGabriel FERNANDEZ keyscan_stop(keypad_data); 188062589b1SGabriel FERNANDEZ 189062589b1SGabriel FERNANDEZ keypad_data->irq = platform_get_irq(pdev, 0); 190062589b1SGabriel FERNANDEZ if (keypad_data->irq < 0) { 191062589b1SGabriel FERNANDEZ dev_err(&pdev->dev, "no IRQ specified\n"); 192062589b1SGabriel FERNANDEZ return -EINVAL; 193062589b1SGabriel FERNANDEZ } 194062589b1SGabriel FERNANDEZ 195062589b1SGabriel FERNANDEZ error = devm_request_irq(&pdev->dev, keypad_data->irq, keyscan_isr, 0, 196062589b1SGabriel FERNANDEZ pdev->name, keypad_data); 197062589b1SGabriel FERNANDEZ if (error) { 198062589b1SGabriel FERNANDEZ dev_err(&pdev->dev, "failed to request IRQ\n"); 199062589b1SGabriel FERNANDEZ return error; 200062589b1SGabriel FERNANDEZ } 201062589b1SGabriel FERNANDEZ 202062589b1SGabriel FERNANDEZ error = input_register_device(input_dev); 203062589b1SGabriel FERNANDEZ if (error) { 204062589b1SGabriel FERNANDEZ dev_err(&pdev->dev, "failed to register input device\n"); 205062589b1SGabriel FERNANDEZ return error; 206062589b1SGabriel FERNANDEZ } 207062589b1SGabriel FERNANDEZ 208062589b1SGabriel FERNANDEZ platform_set_drvdata(pdev, keypad_data); 209062589b1SGabriel FERNANDEZ 210062589b1SGabriel FERNANDEZ device_set_wakeup_capable(&pdev->dev, 1); 211062589b1SGabriel FERNANDEZ 212062589b1SGabriel FERNANDEZ return 0; 213062589b1SGabriel FERNANDEZ } 214062589b1SGabriel FERNANDEZ 2152e58cdccSTobias Klauser #ifdef CONFIG_PM_SLEEP 216062589b1SGabriel FERNANDEZ static int keyscan_suspend(struct device *dev) 217062589b1SGabriel FERNANDEZ { 218062589b1SGabriel FERNANDEZ struct platform_device *pdev = to_platform_device(dev); 219062589b1SGabriel FERNANDEZ struct st_keyscan *keypad = platform_get_drvdata(pdev); 220062589b1SGabriel FERNANDEZ struct input_dev *input = keypad->input_dev; 221062589b1SGabriel FERNANDEZ 222062589b1SGabriel FERNANDEZ mutex_lock(&input->mutex); 223062589b1SGabriel FERNANDEZ 224062589b1SGabriel FERNANDEZ if (device_may_wakeup(dev)) 225062589b1SGabriel FERNANDEZ enable_irq_wake(keypad->irq); 226062589b1SGabriel FERNANDEZ else if (input->users) 227062589b1SGabriel FERNANDEZ keyscan_stop(keypad); 228062589b1SGabriel FERNANDEZ 229062589b1SGabriel FERNANDEZ mutex_unlock(&input->mutex); 230062589b1SGabriel FERNANDEZ return 0; 231062589b1SGabriel FERNANDEZ } 232062589b1SGabriel FERNANDEZ 233062589b1SGabriel FERNANDEZ static int keyscan_resume(struct device *dev) 234062589b1SGabriel FERNANDEZ { 235062589b1SGabriel FERNANDEZ struct platform_device *pdev = to_platform_device(dev); 236062589b1SGabriel FERNANDEZ struct st_keyscan *keypad = platform_get_drvdata(pdev); 237062589b1SGabriel FERNANDEZ struct input_dev *input = keypad->input_dev; 238062589b1SGabriel FERNANDEZ int retval = 0; 239062589b1SGabriel FERNANDEZ 240062589b1SGabriel FERNANDEZ mutex_lock(&input->mutex); 241062589b1SGabriel FERNANDEZ 242062589b1SGabriel FERNANDEZ if (device_may_wakeup(dev)) 243062589b1SGabriel FERNANDEZ disable_irq_wake(keypad->irq); 244062589b1SGabriel FERNANDEZ else if (input->users) 245062589b1SGabriel FERNANDEZ retval = keyscan_start(keypad); 246062589b1SGabriel FERNANDEZ 247062589b1SGabriel FERNANDEZ mutex_unlock(&input->mutex); 248062589b1SGabriel FERNANDEZ return retval; 249062589b1SGabriel FERNANDEZ } 2502e58cdccSTobias Klauser #endif 251062589b1SGabriel FERNANDEZ 252062589b1SGabriel FERNANDEZ static SIMPLE_DEV_PM_OPS(keyscan_dev_pm_ops, keyscan_suspend, keyscan_resume); 253062589b1SGabriel FERNANDEZ 254062589b1SGabriel FERNANDEZ static const struct of_device_id keyscan_of_match[] = { 255062589b1SGabriel FERNANDEZ { .compatible = "st,sti-keyscan" }, 256062589b1SGabriel FERNANDEZ { }, 257062589b1SGabriel FERNANDEZ }; 258062589b1SGabriel FERNANDEZ MODULE_DEVICE_TABLE(of, keyscan_of_match); 259062589b1SGabriel FERNANDEZ 260062589b1SGabriel FERNANDEZ static struct platform_driver keyscan_device_driver = { 261062589b1SGabriel FERNANDEZ .probe = keyscan_probe, 262062589b1SGabriel FERNANDEZ .driver = { 263062589b1SGabriel FERNANDEZ .name = "st-keyscan", 264062589b1SGabriel FERNANDEZ .pm = &keyscan_dev_pm_ops, 265062589b1SGabriel FERNANDEZ .of_match_table = of_match_ptr(keyscan_of_match), 266062589b1SGabriel FERNANDEZ } 267062589b1SGabriel FERNANDEZ }; 268062589b1SGabriel FERNANDEZ 269062589b1SGabriel FERNANDEZ module_platform_driver(keyscan_device_driver); 270062589b1SGabriel FERNANDEZ 271062589b1SGabriel FERNANDEZ MODULE_AUTHOR("Stuart Menefy <stuart.menefy@st.com>"); 272062589b1SGabriel FERNANDEZ MODULE_DESCRIPTION("STMicroelectronics keyscan device driver"); 273062589b1SGabriel FERNANDEZ MODULE_LICENSE("GPL"); 274