diff --git a/boards/arm/mec1501modular_assy6885/mec1501modular_assy6885.dts b/boards/arm/mec1501modular_assy6885/mec1501modular_assy6885.dts index 5b66d1a2bd..7f696fc6e3 100644 --- a/boards/arm/mec1501modular_assy6885/mec1501modular_assy6885.dts +++ b/boards/arm/mec1501modular_assy6885/mec1501modular_assy6885.dts @@ -101,13 +101,15 @@ &ps2_0 { status = "okay"; pinctrl-0 = <&ps2_clk0b_gpio007 &ps2_dat0b_gpio010>; - pinctrl-names = "default"; + pinctrl-1 = <&ps2_clk0b_gpio007_sleep &ps2_dat0b_gpio010_sleep>; + pinctrl-names = "default", "sleep"; }; &ps2_1 { status = "okay"; pinctrl-0 = <&ps2_clk1b_gpio154 &ps2_dat1b_gpio155>; - pinctrl-names = "default"; + pinctrl-1 = <&ps2_clk1b_gpio154_sleep &ps2_dat1b_gpio155_sleep>; + pinctrl-names = "default", "sleep"; }; &pwm0 { diff --git a/boards/arm/mec15xxevb_assy6853/mec15xxevb_assy6853.dts b/boards/arm/mec15xxevb_assy6853/mec15xxevb_assy6853.dts index fbbb1ac5a3..d15c278604 100644 --- a/boards/arm/mec15xxevb_assy6853/mec15xxevb_assy6853.dts +++ b/boards/arm/mec15xxevb_assy6853/mec15xxevb_assy6853.dts @@ -158,13 +158,15 @@ &ps2_0 { status = "okay"; pinctrl-0 = <&ps2_clk0b_gpio007 &ps2_dat0b_gpio010>; - pinctrl-names = "default"; + pinctrl-1 = <&ps2_clk0b_gpio007_sleep &ps2_dat0b_gpio010_sleep>; + pinctrl-names = "default", "sleep"; }; &ps2_1 { status = "okay"; pinctrl-0 = <&ps2_clk1b_gpio154 &ps2_dat1b_gpio155>; - pinctrl-names = "default"; + pinctrl-1 = <&ps2_clk1b_gpio154_sleep &ps2_dat1b_gpio155_sleep>; + pinctrl-names = "default", "sleep"; }; &pwm0 { diff --git a/boards/arm/mec172xevb_assy6906/mec172xevb_assy6906.dts b/boards/arm/mec172xevb_assy6906/mec172xevb_assy6906.dts index ffd7c2427b..d01176bf9a 100644 --- a/boards/arm/mec172xevb_assy6906/mec172xevb_assy6906.dts +++ b/boards/arm/mec172xevb_assy6906/mec172xevb_assy6906.dts @@ -303,7 +303,8 @@ &ps2_0 { status = "okay"; pinctrl-0 = <&ps2_clk0a_gpio114 &ps2_dat0a_gpio115>; - pinctrl-names = "default"; + pinctrl-1 = <&ps2_clk0a_gpio114_sleep &ps2_dat0a_gpio115_sleep>; + pinctrl-names = "default", "sleep"; }; &timer5 { diff --git a/drivers/ps2/ps2_mchp_xec.c b/drivers/ps2/ps2_mchp_xec.c index dd977590c9..f2dd97d273 100644 --- a/drivers/ps2/ps2_mchp_xec.c +++ b/drivers/ps2/ps2_mchp_xec.c @@ -16,10 +16,15 @@ #include #endif #include +#ifdef CONFIG_PM_DEVICE +#include +#include +#endif #include #include #include #include +#include #define LOG_LEVEL CONFIG_PS2_LOG_LEVEL LOG_MODULE_REGISTER(ps2_mchp_xec); @@ -32,17 +37,25 @@ struct ps2_xec_config { int isr_nvic; uint8_t girq_id; uint8_t girq_bit; + uint8_t girq_id_wk; + uint8_t girq_bit_wk; uint8_t pcr_idx; uint8_t pcr_pos; void (*irq_config_func)(void); const struct pinctrl_dev_config *pcfg; +#ifdef CONFIG_PM_DEVICE + struct gpio_dt_spec wakerx_gpio; + bool wakeup_source; +#endif }; + struct ps2_xec_data { ps2_callback_t callback_isr; struct k_sem tx_lock; }; + #ifdef CONFIG_SOC_SERIES_MEC172X static inline void ps2_xec_slp_en_clr(const struct device *dev) { @@ -51,18 +64,19 @@ static inline void ps2_xec_slp_en_clr(const struct device *dev) z_mchp_xec_pcr_periph_sleep(cfg->pcr_idx, cfg->pcr_pos, 0); } -static inline void ps2_xec_girq_clr(const struct device *dev) +static inline void ps2_xec_girq_clr(uint8_t girq_idx, uint8_t girq_posn) { - const struct ps2_xec_config * const cfg = dev->config; - - mchp_soc_ecia_girq_src_clr(cfg->girq_id, cfg->girq_bit); + mchp_soc_ecia_girq_src_clr(girq_idx, girq_posn); } -static inline void ps2_xec_girq_en(const struct device *dev) +static inline void ps2_xec_girq_en(uint8_t girq_idx, uint8_t girq_posn) { - const struct ps2_xec_config * const cfg = dev->config; + mchp_xec_ecia_girq_src_en(girq_idx, girq_posn); +} - mchp_xec_ecia_girq_src_en(cfg->girq_id, cfg->girq_bit); +static inline void ps2_xec_girq_dis(uint8_t girq_idx, uint8_t girq_posn) +{ + mchp_xec_ecia_girq_src_dis(girq_idx, girq_posn); } #else static inline void ps2_xec_slp_en_clr(const struct device *dev) @@ -76,18 +90,19 @@ static inline void ps2_xec_slp_en_clr(const struct device *dev) } } -static inline void ps2_xec_girq_clr(const struct device *dev) +static inline void ps2_xec_girq_clr(uint8_t girq_idx, uint8_t girq_posn) { - const struct ps2_xec_config * const cfg = dev->config; - - MCHP_GIRQ_SRC(cfg->girq_id) = BIT(cfg->girq_bit); + MCHP_GIRQ_SRC(girq_idx) = BIT(girq_posn); } -static inline void ps2_xec_girq_en(const struct device *dev) +static inline void ps2_xec_girq_en(uint8_t girq_idx, uint8_t girq_posn) { - const struct ps2_xec_config * const cfg = dev->config; + MCHP_GIRQ_ENSET(girq_idx) = BIT(girq_posn); +} - MCHP_GIRQ_ENSET(cfg->girq_id) = BIT(cfg->girq_bit); +static inline void ps2_xec_girq_dis(uint8_t girq_idx, uint8_t girq_posn) +{ + MCHP_GIRQ_ENCLR(girq_idx) = MCHP_KBC_IBF_GIRQ; } #endif /* CONFIG_SOC_SERIES_MEC172X */ @@ -108,13 +123,13 @@ static int ps2_xec_configure(const struct device *dev, /* In case the self test for a PS2 device already finished and * set the SOURCE bit to 1 we clear it before enabling the - * interrupts. Instances must be allocated before the BAT or - * the host may time out. + * interrupts. Instances must be allocated before the BAT + * (Basic Assurance Test) or the host may time out. */ temp = regs->TRX_BUFF; regs->STATUS = MCHP_PS2_STATUS_RW1C_MASK; /* clear next higher level */ - ps2_xec_girq_clr(dev); + ps2_xec_girq_clr(config->girq_id, config->girq_bit); /* Enable FSM and init instance in rx mode*/ regs->CTRL = MCHP_PS2_CTRL_EN_POS; @@ -122,7 +137,7 @@ static int ps2_xec_configure(const struct device *dev, /* We enable the interrupts in the EC aggregator so that the * result can be forwarded to the ARM NVIC */ - ps2_xec_girq_en(dev); + ps2_xec_girq_en(config->girq_id, config->girq_bit); k_sem_give(&data->tx_lock); @@ -159,7 +174,9 @@ static int ps2_xec_write(const struct device *dev, uint8_t value) LOG_DBG("PS2 write timed out"); return -ETIMEDOUT; } - +#ifdef CONFIG_PM_DEVICE + pm_policy_state_lock_get(PM_STATE_SUSPEND_TO_IDLE, PM_ALL_SUBSTATES); +#endif /* Inhibit ps2 controller and clear status register */ regs->CTRL = 0x00; @@ -191,7 +208,7 @@ static int ps2_xec_inhibit_interface(const struct device *dev) regs->CTRL = 0x00; regs->STATUS = MCHP_PS2_STATUS_RW1C_MASK; - ps2_xec_girq_clr(dev); + ps2_xec_girq_clr(config->girq_id, config->girq_bit); NVIC_ClearPendingIRQ(config->isr_nvic); k_sem_give(&data->tx_lock); @@ -205,7 +222,7 @@ static int ps2_xec_enable_interface(const struct device *dev) struct ps2_xec_data * const data = dev->data; struct ps2_regs * const regs = config->regs; - ps2_xec_girq_clr(dev); + ps2_xec_girq_clr(config->girq_id, config->girq_bit); regs->CTRL = MCHP_PS2_CTRL_EN; k_sem_give(&data->tx_lock); @@ -213,6 +230,70 @@ static int ps2_xec_enable_interface(const struct device *dev) return 0; } +#ifdef CONFIG_PM_DEVICE +static int ps2_xec_pm_action(const struct device *dev, enum pm_device_action action) +{ + const struct ps2_xec_config *const devcfg = dev->config; + struct ps2_regs * const regs = devcfg->regs; + int ret = 0; + + switch (action) { + case PM_DEVICE_ACTION_RESUME: + if (devcfg->wakeup_source) { + /* Disable PS2 wake interrupt + * Disable interrupt on PS2DAT pin + */ + if (devcfg->wakerx_gpio.port != NULL) { + ret = gpio_pin_interrupt_configure_dt( + &devcfg->wakerx_gpio, + GPIO_INT_DISABLE); + if (ret < 0) { + LOG_ERR("Fail to disable PS2 wake interrupt (ret %d)", ret); + return ret; + } + } + ps2_xec_girq_dis(devcfg->girq_id_wk, devcfg->girq_bit_wk); + ps2_xec_girq_clr(devcfg->girq_id_wk, devcfg->girq_bit_wk); + } else { + ret = pinctrl_apply_state(devcfg->pcfg, PINCTRL_STATE_DEFAULT); + regs->CTRL |= MCHP_PS2_CTRL_EN; + } + break; + case PM_DEVICE_ACTION_SUSPEND: + if (devcfg->wakeup_source) { + /* Enable PS2 wake interrupt + * Configure Falling Edge Trigger interrupt on PS2DAT pin + */ + ps2_xec_girq_clr(devcfg->girq_id_wk, devcfg->girq_bit_wk); + ps2_xec_girq_en(devcfg->girq_id_wk, devcfg->girq_bit_wk); + if (devcfg->wakerx_gpio.port != NULL) { + ret = gpio_pin_interrupt_configure_dt( + &devcfg->wakerx_gpio, + GPIO_INT_MODE_EDGE | GPIO_INT_TRIG_LOW); + if (ret < 0) { + LOG_ERR("Fail to enable PS2 wake interrupt(ret %d)", ret); + return ret; + } + } + } else { + regs->CTRL &= ~MCHP_PS2_CTRL_EN; + /* If application does not want to turn off PS2 pins it will + * not define pinctrl-1 for this node. + */ + ret = pinctrl_apply_state(devcfg->pcfg, PINCTRL_STATE_SLEEP); + if (ret == -ENOENT) { /* pinctrl-1 does not exist. */ + ret = 0; + } + } + break; + default: + ret = -ENOTSUP; + } + + return ret; +} +#endif /* CONFIG_PM_DEVICE */ + static void ps2_xec_isr(const struct device *dev) { const struct ps2_xec_config * const config = dev->config; @@ -224,18 +305,36 @@ static void ps2_xec_isr(const struct device *dev) status = regs->STATUS; /* clear next higher level the GIRQ */ - ps2_xec_girq_clr(dev); + ps2_xec_girq_clr(config->girq_id, config->girq_bit); if (status & MCHP_PS2_STATUS_RXD_RDY) { +#ifdef CONFIG_PM_DEVICE + pm_policy_state_lock_get(PM_STATE_SUSPEND_TO_IDLE, PM_ALL_SUBSTATES); +#endif regs->CTRL = 0x00; if (data->callback_isr) { data->callback_isr(dev, regs->TRX_BUFF); } +#ifdef CONFIG_PM_DEVICE + pm_policy_state_lock_put(PM_STATE_SUSPEND_TO_IDLE, PM_ALL_SUBSTATES); +#endif } else if (status & (MCHP_PS2_STATUS_TX_TMOUT | MCHP_PS2_STATUS_TX_ST_TMOUT)) { /* Clear sticky bits and go to read mode */ regs->STATUS = MCHP_PS2_STATUS_RW1C_MASK; LOG_ERR("TX time out: %0x", status); +#ifdef CONFIG_PM_DEVICE + pm_policy_state_lock_put(PM_STATE_SUSPEND_TO_IDLE, PM_ALL_SUBSTATES); +#endif + } else if (status & + (MCHP_PS2_STATUS_RX_TMOUT | MCHP_PS2_STATUS_PE | MCHP_PS2_STATUS_FE)) { + /* catch and clear rx error if any */ + regs->STATUS = MCHP_PS2_STATUS_RW1C_MASK; + } else if (status & MCHP_PS2_STATUS_TX_IDLE) { + /* Transfer completed, release the lock to enter low per mode */ +#ifdef CONFIG_PM_DEVICE + pm_policy_state_lock_put(PM_STATE_SUSPEND_TO_IDLE, PM_ALL_SUBSTATES); +#endif } /* The control register reverts to RX automatically after @@ -256,9 +355,7 @@ static int ps2_xec_init(const struct device *dev) { const struct ps2_xec_config * const cfg = dev->config; struct ps2_xec_data * const data = dev->data; - int ret = pinctrl_apply_state(cfg->pcfg, PINCTRL_STATE_DEFAULT); - if (ret != 0) { LOG_ERR("XEC PS2 pinctrl init failed (%d)", ret); return ret; @@ -273,16 +370,35 @@ static int ps2_xec_init(const struct device *dev) return 0; } +/* To enable wakeup on the PS2, the DTS needs to have two entries defined + * in the corresponding PS2 node in the DTS specifying it as a wake source + * and specifying the PS2DAT GPIO; example as below + * + * wakerx-gpios = + * wakeup-source; + */ +#ifdef CONFIG_PM_DEVICE +#define XEC_PS2_PM_WAKEUP(n) \ + .wakeup_source = (uint8_t)DT_INST_PROP_OR(n, wakeup_source, 0), \ + .wakerx_gpio = GPIO_DT_SPEC_INST_GET_OR(n, wakerx_gpios, {0}), +#else +#define XEC_PS2_PM_WAKEUP(index) /* Not used */ +#endif + +#define XEC_PS2_PINCTRL_CFG(inst) PINCTRL_DT_INST_DEFINE(inst) #define XEC_PS2_CONFIG(inst) \ static const struct ps2_xec_config ps2_xec_config_##inst = { \ .regs = (struct ps2_regs * const)(DT_INST_REG_ADDR(inst)), \ .isr_nvic = DT_INST_IRQN(inst), \ .girq_id = (uint8_t)(DT_INST_PROP_BY_IDX(inst, girqs, 0)), \ .girq_bit = (uint8_t)(DT_INST_PROP_BY_IDX(inst, girqs, 1)), \ + .girq_id_wk = (uint8_t)(DT_INST_PROP_BY_IDX(inst, girqs, 2)), \ + .girq_bit_wk = (uint8_t)(DT_INST_PROP_BY_IDX(inst, girqs, 3)), \ .pcr_idx = (uint8_t)(DT_INST_PROP_BY_IDX(inst, pcrs, 0)), \ .pcr_pos = (uint8_t)(DT_INST_PROP_BY_IDX(inst, pcrs, 1)), \ .irq_config_func = ps2_xec_irq_config_func_##inst, \ .pcfg = PINCTRL_DT_INST_DEV_CONFIG_GET(inst), \ + XEC_PS2_PM_WAKEUP(inst) \ } #define PS2_XEC_DEVICE(i) \ @@ -298,12 +414,14 @@ static int ps2_xec_init(const struct device *dev) \ static struct ps2_xec_data ps2_xec_port_data_##i; \ \ - PINCTRL_DT_INST_DEFINE(i); \ + XEC_PS2_PINCTRL_CFG(i); \ \ XEC_PS2_CONFIG(i); \ \ + PM_DEVICE_DT_INST_DEFINE(i, ps2_xec_pm_action); \ + \ DEVICE_DT_INST_DEFINE(i, &ps2_xec_init, \ - NULL, \ + PM_DEVICE_DT_INST_GET(i), \ &ps2_xec_port_data_##i, &ps2_xec_config_##i, \ POST_KERNEL, CONFIG_PS2_INIT_PRIORITY, \ &ps2_xec_driver_api); diff --git a/dts/arm/microchip/mec1501hsz.dtsi b/dts/arm/microchip/mec1501hsz.dtsi index 4700a2d746..dade0c7ca1 100644 --- a/dts/arm/microchip/mec1501hsz.dtsi +++ b/dts/arm/microchip/mec1501hsz.dtsi @@ -342,7 +342,7 @@ compatible = "microchip,xec-ps2"; reg = <0x40009000 0x40>; interrupts = <100 1>; - girqs = <18 10>; + girqs = <18 10>, <21 18>; pcrs = <3 5>; #address-cells = <1>; #size-cells = <0>; @@ -352,7 +352,7 @@ compatible = "microchip,xec-ps2"; reg = <0x40009040 0x40>; interrupts = <101 1>; - girqs = <18 11>; + girqs = <18 11>, <21 21>; pcrs = <3 6>; #address-cells = <1>; #size-cells = <0>; diff --git a/dts/arm/microchip/mec152x/mec152xhsz-pinctrl.dtsi b/dts/arm/microchip/mec152x/mec152xhsz-pinctrl.dtsi index ba1556519a..3625736add 100644 --- a/dts/arm/microchip/mec152x/mec152xhsz-pinctrl.dtsi +++ b/dts/arm/microchip/mec152x/mec152xhsz-pinctrl.dtsi @@ -1070,4 +1070,22 @@ pinmux = < MCHP_XEC_PINMUX(044, MCHP_AF1) >; low-power-enable; }; + + /* PS2 */ + ps2_clk0b_gpio007_sleep: ps2_clk0b_gpio007_sleep { + pinmux = < MCHP_XEC_PINMUX(007, MCHP_AF2) >; + low-power-enable; + }; + ps2_dat0b_gpio010_sleep: ps2_dat0b_gpio010_sleep { + pinmux = < MCHP_XEC_PINMUX(010, MCHP_AF2) >; + low-power-enable; + }; + ps2_clk1b_gpio154_sleep: ps2_clk1b_gpio154_sleep { + pinmux = < MCHP_XEC_PINMUX(0154, MCHP_AF2) >; + low-power-enable; + }; + ps2_dat1b_gpio155_sleep: ps2_dat1b_gpio155_sleep { + pinmux = < MCHP_XEC_PINMUX(0155, MCHP_AF2) >; + low-power-enable; + }; }; diff --git a/dts/arm/microchip/mec172x/mec172xnsz-pinctrl.dtsi b/dts/arm/microchip/mec172x/mec172xnsz-pinctrl.dtsi index 6968c1c3cf..b218d28c6d 100644 --- a/dts/arm/microchip/mec172x/mec172xnsz-pinctrl.dtsi +++ b/dts/arm/microchip/mec172x/mec172xnsz-pinctrl.dtsi @@ -1102,4 +1102,15 @@ pinmux = < MCHP_XEC_PINMUX(044, MCHP_AF1) >; low-power-enable; }; + + ps2_clk0a_gpio114_sleep: ps2_clk0a_gpio114_sleep { + pinmux = < MCHP_XEC_PINMUX(0114, MCHP_AF1) >; + low-power-enable; + }; + + ps2_dat0a_gpio115_sleep: ps2_dat0a_gpio115_sleep { + pinmux = < MCHP_XEC_PINMUX(0115, MCHP_AF1) >; + low-power-enable; + }; + }; diff --git a/dts/arm/microchip/mec172xnsz.dtsi b/dts/arm/microchip/mec172xnsz.dtsi index ca65168b8d..75a059e046 100644 --- a/dts/arm/microchip/mec172xnsz.dtsi +++ b/dts/arm/microchip/mec172xnsz.dtsi @@ -565,7 +565,7 @@ compatible = "microchip,xec-ps2"; reg = <0x40009000 0x40>; interrupts = <100 1>; - girqs = <18 10>; + girqs = <18 10>, <21 18>; pcrs = <3 5>; #address-cells = <1>; #size-cells = <0>; diff --git a/dts/bindings/ps2/microchip,xec-ps2.yaml b/dts/bindings/ps2/microchip,xec-ps2.yaml index 0480b5ed05..b3521f960f 100644 --- a/dts/bindings/ps2/microchip,xec-ps2.yaml +++ b/dts/bindings/ps2/microchip,xec-ps2.yaml @@ -25,3 +25,7 @@ properties: type: array required: true description: PS2 PCR register index and bit position + + wakerx-gpios: + type: phandle-array + description: GPIO configured as PS2 DAT wake source diff --git a/samples/drivers/ps2/prj.conf b/samples/drivers/ps2/prj.conf index 01cb3bb233..743787bd85 100644 --- a/samples/drivers/ps2/prj.conf +++ b/samples/drivers/ps2/prj.conf @@ -1,4 +1,4 @@ CONFIG_STDOUT_CONSOLE=y CONFIG_PRINTK=y CONFIG_PS2=y - +CONFIG_PM_DEVICE=y diff --git a/soc/arm/microchip_mec/mec172x/device_power.c b/soc/arm/microchip_mec/mec172x/device_power.c index cf7d412171..8a35d6ddd0 100644 --- a/soc/arm/microchip_mec/mec172x/device_power.c +++ b/soc/arm/microchip_mec/mec172x/device_power.c @@ -92,14 +92,15 @@ void soc_deep_sleep_non_wake_dis(void) /* When MEC172x drivers are power-aware this should be move there */ void soc_deep_sleep_wake_en(void) { -#if defined(CONFIG_KSCAN) || DT_NODE_HAS_STATUS(DT_NODELABEL(ps2_0), okay) +#if defined(CONFIG_KSCAN) || \ + (!defined(CONFIG_PM_DEVICE) && DT_NODE_HAS_STATUS(DT_NODELABEL(ps2_0), okay)) struct ecia_named_regs *regs = ECIA_XEC_REG_BASE; #if defined(CONFIG_KSCAN) /* Enable PLL wake via KSCAN */ regs->GIRQ21.SRC = MCHP_KEYSCAN_GIRQ_BIT; regs->GIRQ21.EN_SET = MCHP_KEYSCAN_GIRQ_BIT; #endif -#if DT_NODE_HAS_STATUS(DT_NODELABEL(ps2_0), okay) +#if !defined(CONFIG_PM_DEVICE) && DT_NODE_HAS_STATUS(DT_NODELABEL(ps2_0), okay) /* Enable PS2_0B_WK */ regs->GIRQ21.SRC = MCHP_PS2_0_PORT0B_WK_GIRQ_BIT; regs->GIRQ21.EN_SET = MCHP_PS2_0_PORT0B_WK_GIRQ_BIT; @@ -109,7 +110,7 @@ void soc_deep_sleep_wake_en(void) void soc_deep_sleep_wake_dis(void) { -#if DT_NODE_HAS_STATUS(DT_NODELABEL(ps2_0), okay) +#if !defined(CONFIG_PM_DEVICE) && DT_NODE_HAS_STATUS(DT_NODELABEL(ps2_0), okay) struct ecia_named_regs *regs = ECIA_XEC_REG_BASE; /* Enable PS2_0B_WK */