drivers/pwm/pwm-cros-ec.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * Expose a PWM controlled by the ChromeOS EC to the host processor.
   4  *
   5  * Copyright (C) 2016 Google, Inc.
   6  */
   7
   8 #include <linux/module.h>
   9 #include <linux/platform_data/cros_ec_commands.h>
  10 #include <linux/platform_data/cros_ec_proto.h>
  11 #include <linux/platform_device.h>
  12 #include <linux/pwm.h>
  13 #include <linux/slab.h>
  14
  15 /**
  16  * struct cros_ec_pwm_device - Driver data for EC PWM
  17  *
  18  * @dev: Device node
  19  * @ec: Pointer to EC device
  20  * @chip: PWM controller chip
  21  */
  22 struct cros_ec_pwm_device {
  23         struct device *dev;
  24         struct cros_ec_device *ec;
  25         struct pwm_chip chip;
  26 };
  27
  28 /**
  29  * struct cros_ec_pwm - per-PWM driver data
  30  * @duty_cycle: cached duty cycle
  31  */
  32 struct cros_ec_pwm {
  33         u16 duty_cycle;
  34 };
  35
  36 static inline struct cros_ec_pwm_device *pwm_to_cros_ec_pwm(struct pwm_chip *c)
  37 {
  38         return container_of(c, struct cros_ec_pwm_device, chip);
  39 }
  40
  41 static int cros_ec_pwm_request(struct pwm_chip *chip, struct pwm_device *pwm)
  42 {
  43         struct cros_ec_pwm *channel;
  44
  45         channel = kzalloc(sizeof(*channel), GFP_KERNEL);
  46         if (!channel)
  47                 return -ENOMEM;
  48
  49         pwm_set_chip_data(pwm, channel);
  50
  51         return 0;
  52 }
  53
  54 static void cros_ec_pwm_free(struct pwm_chip *chip, struct pwm_device *pwm)
  55 {
  56         struct cros_ec_pwm *channel = pwm_get_chip_data(pwm);
  57
  58         kfree(channel);
  59 }
  60
  61 static int cros_ec_pwm_set_duty(struct cros_ec_device *ec, u8 index, u16 duty)
  62 {
  63         struct {
  64                 struct cros_ec_command msg;
  65                 struct ec_params_pwm_set_duty params;
  66         } __packed buf;
  67         struct ec_params_pwm_set_duty *params = &buf.params;
  68         struct cros_ec_command *msg = &buf.msg;
  69
  70         memset(&buf, 0, sizeof(buf));
  71
  72         msg->version = 0;
  73         msg->command = EC_CMD_PWM_SET_DUTY;
  74         msg->insize = 0;
  75         msg->outsize = sizeof(*params);
  76
  77         params->duty = duty;
  78         params->pwm_type = EC_PWM_TYPE_GENERIC;
  79         params->index = index;
  80
  81         return cros_ec_cmd_xfer_status(ec, msg);
  82 }
  83
  84 static int __cros_ec_pwm_get_duty(struct cros_ec_device *ec, u8 index,
  85                                   u32 *result)
  86 {
  87         struct {
  88                 struct cros_ec_command msg;
  89                 union {
  90                         struct ec_params_pwm_get_duty params;
  91                         struct ec_response_pwm_get_duty resp;
  92                 };
  93         } __packed buf;
  94         struct ec_params_pwm_get_duty *params = &buf.params;
  95         struct ec_response_pwm_get_duty *resp = &buf.resp;
  96         struct cros_ec_command *msg = &buf.msg;
  97         int ret;
  98
  99         memset(&buf, 0, sizeof(buf));
 100
 101         msg->version = 0;
 102         msg->command = EC_CMD_PWM_GET_DUTY;
 103         msg->insize = sizeof(*resp);
 104         msg->outsize = sizeof(*params);
 105
 106         params->pwm_type = EC_PWM_TYPE_GENERIC;
 107         params->index = index;
 108
 109         ret = cros_ec_cmd_xfer_status(ec, msg);
 110         if (result)
 111                 *result = msg->result;
 112         if (ret < 0)
 113                 return ret;
 114
 115         return resp->duty;
 116 }
 117
 118 static int cros_ec_pwm_get_duty(struct cros_ec_device *ec, u8 index)
 119 {
 120         return __cros_ec_pwm_get_duty(ec, index, NULL);
 121 }
 122
 123 static int cros_ec_pwm_apply(struct pwm_chip *chip, struct pwm_device *pwm,
 124                              const struct pwm_state *state)
 125 {
 126         struct cros_ec_pwm_device *ec_pwm = pwm_to_cros_ec_pwm(chip);
 127         struct cros_ec_pwm *channel = pwm_get_chip_data(pwm);
 128         u16 duty_cycle;
 129         int ret;
 130
 131         /* The EC won't let us change the period */
 132         if (state->period != EC_PWM_MAX_DUTY)
 133                 return -EINVAL;
 134
 135         /*
 136          * EC doesn't separate the concept of duty cycle and enabled, but
 137          * kernel does. Translate.
 138          */
 139         duty_cycle = state->enabled ? state->duty_cycle : 0;
 140
 141         ret = cros_ec_pwm_set_duty(ec_pwm->ec, pwm->hwpwm, duty_cycle);
 142         if (ret < 0)
 143                 return ret;
 144
 145         channel->duty_cycle = state->duty_cycle;
 146
 147         return 0;
 148 }
 149
 150 static void cros_ec_pwm_get_state(struct pwm_chip *chip, struct pwm_device *pwm,
 151                                   struct pwm_state *state)
 152 {
 153         struct cros_ec_pwm_device *ec_pwm = pwm_to_cros_ec_pwm(chip);
 154         struct cros_ec_pwm *channel = pwm_get_chip_data(pwm);
 155         int ret;
 156
 157         ret = cros_ec_pwm_get_duty(ec_pwm->ec, pwm->hwpwm);
 158         if (ret < 0) {
 159                 dev_err(chip->dev, "error getting initial duty: %d\n", ret);
 160                 return;
 161         }
 162
 163         state->enabled = (ret > 0);
 164         state->period = EC_PWM_MAX_DUTY;
 165
 166         /*
 167          * Note that "disabled" and "duty cycle == 0" are treated the same. If
 168          * the cached duty cycle is not zero, used the cached duty cycle. This
 169          * ensures that the configured duty cycle is kept across a disable and
 170          * enable operation and avoids potentially confusing consumers.
 171          *
 172          * For the case of the initial hardware readout, channel->duty_cycle
 173          * will be 0 and the actual duty cycle read from the EC is used.
 174          */
 175         if (ret == 0 && channel->duty_cycle > 0)
 176                 state->duty_cycle = channel->duty_cycle;
 177         else
 178                 state->duty_cycle = ret;
 179 }
 180
 181 static struct pwm_device *
 182 cros_ec_pwm_xlate(struct pwm_chip *pc, const struct of_phandle_args *args)
 183 {
 184         struct pwm_device *pwm;
 185
 186         if (args->args[0] >= pc->npwm)
 187                 return ERR_PTR(-EINVAL);
 188
 189         pwm = pwm_request_from_chip(pc, args->args[0], NULL);
 190         if (IS_ERR(pwm))
 191                 return pwm;
 192
 193         /* The EC won't let us change the period */
 194         pwm->args.period = EC_PWM_MAX_DUTY;
 195
 196         return pwm;
 197 }
 198
 199 static const struct pwm_ops cros_ec_pwm_ops = {
 200         .request = cros_ec_pwm_request,
 201         .free = cros_ec_pwm_free,
 202         .get_state      = cros_ec_pwm_get_state,
 203         .apply          = cros_ec_pwm_apply,
 204         .owner          = THIS_MODULE,
 205 };
 206
 207 /*
 208  * Determine the number of supported PWMs. The EC does not return the number
 209  * of PWMs it supports directly, so we have to read the pwm duty cycle for
 210  * subsequent channels until we get an error.
 211  */
 212 static int cros_ec_num_pwms(struct cros_ec_device *ec)
 213 {
 214         int i, ret;
 215
 216         /* The index field is only 8 bits */
 217         for (i = 0; i <= U8_MAX; i++) {
 218                 u32 result = 0;
 219
 220                 ret = __cros_ec_pwm_get_duty(ec, i, &result);
 221                 /*
 222                  * We look for SUCCESS, INVALID_COMMAND, or INVALID_PARAM
 223                  * responses; everything else is treated as an error.
 224                  * The EC error codes either map to -EOPNOTSUPP / -EINVAL,
 225                  * or -EPROTO is returned and the EC error is in the result
 226                  * field. Check for both.
 227                  */
 228                 switch (ret) {
 229                 case -EOPNOTSUPP:       /* invalid command */
 230                         return -ENODEV;
 231                 case -EINVAL:           /* invalid parameter */
 232                         return i;
 233                 case -EPROTO:
 234                         /* Old or new error return code: Handle both */
 235                         if (result == EC_RES_INVALID_COMMAND)
 236                                 return -ENODEV;
 237                         else if (result == EC_RES_INVALID_PARAM)
 238                                 return i;
 239                         return -EPROTO;
 240                 default:
 241                         if (ret < 0)
 242                                 return ret;
 243                         break;
 244                 }
 245         }
 246
 247         return U8_MAX;
 248 }
 249
 250 static int cros_ec_pwm_probe(struct platform_device *pdev)
 251 {
 252         struct cros_ec_device *ec = dev_get_drvdata(pdev->dev.parent);
 253         struct device *dev = &pdev->dev;
 254         struct cros_ec_pwm_device *ec_pwm;
 255         struct pwm_chip *chip;
 256         int ret;
 257
 258         if (!ec) {
 259                 dev_err(dev, "no parent EC device\n");
 260                 return -EINVAL;
 261         }
 262
 263         ec_pwm = devm_kzalloc(dev, sizeof(*ec_pwm), GFP_KERNEL);
 264         if (!ec_pwm)
 265                 return -ENOMEM;
 266         chip = &ec_pwm->chip;
 267         ec_pwm->ec = ec;
 268
 269         /* PWM chip */
 270         chip->dev = dev;
 271         chip->ops = &cros_ec_pwm_ops;
 272         chip->of_xlate = cros_ec_pwm_xlate;
 273         chip->of_pwm_n_cells = 1;
 274         chip->base = -1;
 275         ret = cros_ec_num_pwms(ec);
 276         if (ret < 0) {
 277                 dev_err(dev, "Couldn't find PWMs: %d\n", ret);
 278                 return ret;
 279         }
 280         chip->npwm = ret;
 281         dev_dbg(dev, "Probed %u PWMs\n", chip->npwm);
 282
 283         ret = pwmchip_add(chip);
 284         if (ret < 0) {
 285                 dev_err(dev, "cannot register PWM: %d\n", ret);
 286                 return ret;
 287         }
 288
 289         platform_set_drvdata(pdev, ec_pwm);
 290
 291         return ret;
 292 }
 293
 294 static int cros_ec_pwm_remove(struct platform_device *dev)
 295 {
 296         struct cros_ec_pwm_device *ec_pwm = platform_get_drvdata(dev);
 297         struct pwm_chip *chip = &ec_pwm->chip;
 298
 299         return pwmchip_remove(chip);
 300 }
 301
 302 #ifdef CONFIG_OF
 303 static const struct of_device_id cros_ec_pwm_of_match[] = {
 304         { .compatible = "google,cros-ec-pwm" },
 305         {},
 306 };
 307 MODULE_DEVICE_TABLE(of, cros_ec_pwm_of_match);
 308 #endif
 309
 310 static struct platform_driver cros_ec_pwm_driver = {
 311         .probe = cros_ec_pwm_probe,
 312         .remove = cros_ec_pwm_remove,
 313         .driver = {
 314                 .name = "cros-ec-pwm",
 315                 .of_match_table = of_match_ptr(cros_ec_pwm_of_match),
 316         },
 317 };
 318 module_platform_driver(cros_ec_pwm_driver);
 319
 320 MODULE_ALIAS("platform:cros-ec-pwm");
 321 MODULE_DESCRIPTION("ChromeOS EC PWM driver");
 322 MODULE_LICENSE("GPL v2");