drivers/clk/qcom/gdsc.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /*
   3  * Copyright (c) 2015, 2017-2018, 2022, The Linux Foundation. All rights reserved.
   4  */
   5
   6 #ifndef __QCOM_GDSC_H__
   7 #define __QCOM_GDSC_H__
   8
   9 #include <linux/err.h>
  10 #include <linux/pm_domain.h>
  11
  12 struct regmap;
  13 struct regulator;
  14 struct reset_controller_dev;
  15
  16 /**
  17  * struct gdsc - Globally Distributed Switch Controller
  18  * @pd: generic power domain
  19  * @regmap: regmap for MMIO accesses
  20  * @gdscr: gsdc control register
  21  * @collapse_ctrl: APCS collapse-vote register
  22  * @collapse_mask: APCS collapse-vote mask
  23  * @gds_hw_ctrl: gds_hw_ctrl register
  24  * @cxcs: offsets of branch registers to toggle mem/periph bits in
  25  * @cxc_count: number of @cxcs
  26  * @pwrsts: Possible powerdomain power states
  27  * @en_rest_wait_val: transition delay value for receiving enr ack signal
  28  * @en_few_wait_val: transition delay value for receiving enf ack signal
  29  * @clk_dis_wait_val: transition delay value for halting clock
  30  * @resets: ids of resets associated with this gdsc
  31  * @reset_count: number of @resets
  32  * @rcdev: reset controller
  33  * @dev: the device holding the GDSC, used for pm_runtime calls
  34  */
  35 struct gdsc {
  36         struct generic_pm_domain        pd;
  37         struct generic_pm_domain        *parent;
  38         struct regmap                   *regmap;
  39         unsigned int                    gdscr;
  40         unsigned int                    collapse_ctrl;
  41         unsigned int                    collapse_mask;
  42         unsigned int                    gds_hw_ctrl;
  43         unsigned int                    clamp_io_ctrl;
  44         unsigned int                    *cxcs;
  45         unsigned int                    cxc_count;
  46         unsigned int                    en_rest_wait_val;
  47         unsigned int                    en_few_wait_val;
  48         unsigned int                    clk_dis_wait_val;
  49         const u8                        pwrsts;
  50 /* Powerdomain allowable state bitfields */
  51 #define PWRSTS_OFF              BIT(0)
  52 /*
  53  * There is no SW control to transition a GDSC into
  54  * PWRSTS_RET. This happens in HW when the parent
  55  * domain goes down to a low power state
  56  */
  57 #define PWRSTS_RET              BIT(1)
  58 #define PWRSTS_ON               BIT(2)
  59 #define PWRSTS_OFF_ON           (PWRSTS_OFF | PWRSTS_ON)
  60 #define PWRSTS_RET_ON           (PWRSTS_RET | PWRSTS_ON)
  61         const u16                       flags;
  62 #define VOTABLE         BIT(0)
  63 #define CLAMP_IO        BIT(1)
  64 #define HW_CTRL         BIT(2)
  65 #define SW_RESET        BIT(3)
  66 #define AON_RESET       BIT(4)
  67 #define POLL_CFG_GDSCR  BIT(5)
  68 #define ALWAYS_ON       BIT(6)
  69 #define RETAIN_FF_ENABLE        BIT(7)
  70 #define NO_RET_PERIPH   BIT(8)
  71         struct reset_controller_dev     *rcdev;
  72         unsigned int                    *resets;
  73         unsigned int                    reset_count;
  74
  75         const char                      *supply;
  76         struct regulator                *rsupply;
  77         struct device                   *dev;
  78 };
  79
  80 struct gdsc_desc {
  81         struct device *dev;
  82         struct gdsc **scs;
  83         size_t num;
  84 };
  85
  86 #ifdef CONFIG_QCOM_GDSC
  87 int gdsc_register(struct gdsc_desc *desc, struct reset_controller_dev *,
  88                   struct regmap *);
  89 void gdsc_unregister(struct gdsc_desc *desc);
  90 int gdsc_gx_do_nothing_enable(struct generic_pm_domain *domain);
  91 #else
  92 static inline int gdsc_register(struct gdsc_desc *desc,
  93                                 struct reset_controller_dev *rcdev,
  94                                 struct regmap *r)
  95 {
  96         return -ENOSYS;
  97 }
  98
  99 static inline void gdsc_unregister(struct gdsc_desc *desc) {};
 100 #endif /* CONFIG_QCOM_GDSC */
 101 #endif /* __QCOM_GDSC_H__ */