drivers/misc/mei/wd.c

   1 /*
   2  *
   3  * Intel Management Engine Interface (Intel MEI) Linux driver
   4  * Copyright (c) 2003-2012, Intel Corporation.
   5  *
   6  * This program is free software; you can redistribute it and/or modify it
   7  * under the terms and conditions of the GNU General Public License,
   8  * version 2, as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope it will be useful, but WITHOUT
  11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  13  * more details.
  14  *
  15  */
  16 #include <linux/kernel.h>
  17 #include <linux/module.h>
  18 #include <linux/moduleparam.h>
  19 #include <linux/device.h>
  20 #include <linux/sched.h>
  21 #include <linux/watchdog.h>
  22
  23 #include <linux/mei.h>
  24
  25 #include "mei_dev.h"
  26 #include "hbm.h"
  27 #include "client.h"
  28
  29 static const u8 mei_start_wd_params[] = { 0x02, 0x12, 0x13, 0x10 };
  30 static const u8 mei_stop_wd_params[] = { 0x02, 0x02, 0x14, 0x10 };
  31
  32 /*
  33  * AMT Watchdog Device
  34  */
  35 #define INTEL_AMT_WATCHDOG_ID "INTCAMT"
  36
  37 /* UUIDs for AMT F/W clients */
  38 const uuid_le mei_wd_guid = UUID_LE(0x05B79A6F, 0x4628, 0x4D7F, 0x89,
  39                                                 0x9D, 0xA9, 0x15, 0x14, 0xCB,
  40                                                 0x32, 0xAB);
  41
  42 static void mei_wd_set_start_timeout(struct mei_device *dev, u16 timeout)
  43 {
  44         dev_dbg(dev->dev, "wd: set timeout=%d.\n", timeout);
  45         memcpy(dev->wd_data, mei_start_wd_params, MEI_WD_HDR_SIZE);
  46         memcpy(dev->wd_data + MEI_WD_HDR_SIZE, &timeout, sizeof(u16));
  47 }
  48
  49 /**
  50  * mei_wd_host_init - connect to the watchdog client
  51  *
  52  * @dev: the device structure
  53  *
  54  * Return: -ENOTTY if wd client cannot be found
  55  *         -EIO if write has failed
  56  *         0 on success
  57  */
  58 int mei_wd_host_init(struct mei_device *dev)
  59 {
  60         struct mei_cl *cl = &dev->wd_cl;
  61         struct mei_me_client *me_cl;
  62         int ret;
  63
  64         mei_cl_init(cl, dev);
  65
  66         dev->wd_timeout = MEI_WD_DEFAULT_TIMEOUT;
  67         dev->wd_state = MEI_WD_IDLE;
  68
  69
  70         /* check for valid client id */
  71         me_cl = mei_me_cl_by_uuid(dev, &mei_wd_guid);
  72         if (!me_cl) {
  73                 dev_info(dev->dev, "wd: failed to find the client\n");
  74                 return -ENOTTY;
  75         }
  76
  77         cl->me_client_id = me_cl->client_id;
  78         cl->cl_uuid = me_cl->props.protocol_name;
  79         mei_me_cl_put(me_cl);
  80
  81         ret = mei_cl_link(cl, MEI_WD_HOST_CLIENT_ID);
  82
  83         if (ret < 0) {
  84                 dev_info(dev->dev, "wd: failed link client\n");
  85                 return ret;
  86         }
  87
  88         ret = mei_cl_connect(cl, NULL);
  89
  90         if (ret) {
  91                 dev_err(dev->dev, "wd: failed to connect = %d\n", ret);
  92                 mei_cl_unlink(cl);
  93                 return ret;
  94         }
  95
  96         ret = mei_watchdog_register(dev);
  97         if (ret) {
  98                 mei_cl_disconnect(cl);
  99                 mei_cl_unlink(cl);
 100         }
 101         return ret;
 102 }
 103
 104 /**
 105  * mei_wd_send - sends watch dog message to fw.
 106  *
 107  * @dev: the device structure
 108  *
 109  * Return: 0 if success,
 110  *      -EIO when message send fails
 111  *      -EINVAL when invalid message is to be sent
 112  *      -ENODEV on flow control failure
 113  */
 114 int mei_wd_send(struct mei_device *dev)
 115 {
 116         struct mei_cl *cl = &dev->wd_cl;
 117         struct mei_msg_hdr hdr;
 118         int ret;
 119
 120         hdr.host_addr = cl->host_client_id;
 121         hdr.me_addr = cl->me_client_id;
 122         hdr.msg_complete = 1;
 123         hdr.reserved = 0;
 124         hdr.internal = 0;
 125
 126         if (!memcmp(dev->wd_data, mei_start_wd_params, MEI_WD_HDR_SIZE))
 127                 hdr.length = MEI_WD_START_MSG_SIZE;
 128         else if (!memcmp(dev->wd_data, mei_stop_wd_params, MEI_WD_HDR_SIZE))
 129                 hdr.length = MEI_WD_STOP_MSG_SIZE;
 130         else {
 131                 dev_err(dev->dev, "wd: invalid message is to be sent, aborting\n");
 132                 return -EINVAL;
 133         }
 134
 135         ret = mei_write_message(dev, &hdr, dev->wd_data);
 136         if (ret) {
 137                 dev_err(dev->dev, "wd: write message failed\n");
 138                 return ret;
 139         }
 140
 141         ret = mei_cl_flow_ctrl_reduce(cl);
 142         if (ret) {
 143                 dev_err(dev->dev, "wd: flow_ctrl_reduce failed.\n");
 144                 return ret;
 145         }
 146
 147         return 0;
 148 }
 149
 150 /**
 151  * mei_wd_stop - sends watchdog stop message to fw.
 152  *
 153  * @dev: the device structure
 154  *
 155  * Return: 0 if success
 156  * on error:
 157  *      -EIO    when message send fails
 158  *      -EINVAL when invalid message is to be sent
 159  *      -ETIME  on message timeout
 160  */
 161 int mei_wd_stop(struct mei_device *dev)
 162 {
 163         int ret;
 164
 165         if (dev->wd_cl.state != MEI_FILE_CONNECTED ||
 166             dev->wd_state != MEI_WD_RUNNING)
 167                 return 0;
 168
 169         memcpy(dev->wd_data, mei_stop_wd_params, MEI_WD_STOP_MSG_SIZE);
 170
 171         dev->wd_state = MEI_WD_STOPPING;
 172
 173         ret = mei_cl_flow_ctrl_creds(&dev->wd_cl);
 174         if (ret < 0)
 175                 goto err;
 176
 177         if (ret && mei_hbuf_acquire(dev)) {
 178                 ret = mei_wd_send(dev);
 179                 if (ret)
 180                         goto err;
 181                 dev->wd_pending = false;
 182         } else {
 183                 dev->wd_pending = true;
 184         }
 185
 186         mutex_unlock(&dev->device_lock);
 187
 188         ret = wait_event_timeout(dev->wait_stop_wd,
 189                                 dev->wd_state == MEI_WD_IDLE,
 190                                 msecs_to_jiffies(MEI_WD_STOP_TIMEOUT));
 191         mutex_lock(&dev->device_lock);
 192         if (dev->wd_state != MEI_WD_IDLE) {
 193                 /* timeout */
 194                 ret = -ETIME;
 195                 dev_warn(dev->dev, "wd: stop failed to complete ret=%d\n", ret);
 196                 goto err;
 197         }
 198         dev_dbg(dev->dev, "wd: stop completed after %u msec\n",
 199                         MEI_WD_STOP_TIMEOUT - jiffies_to_msecs(ret));
 200         return 0;
 201 err:
 202         return ret;
 203 }
 204
 205 /*
 206  * mei_wd_ops_start - wd start command from the watchdog core.
 207  *
 208  * @wd_dev - watchdog device struct
 209  *
 210  * Return: 0 if success, negative errno code for failure
 211  */
 212 static int mei_wd_ops_start(struct watchdog_device *wd_dev)
 213 {
 214         int err = -ENODEV;
 215         struct mei_device *dev;
 216
 217         dev = watchdog_get_drvdata(wd_dev);
 218         if (!dev)
 219                 return -ENODEV;
 220
 221         mutex_lock(&dev->device_lock);
 222
 223         if (dev->dev_state != MEI_DEV_ENABLED) {
 224                 dev_dbg(dev->dev, "wd: dev_state != MEI_DEV_ENABLED  dev_state = %s\n",
 225                         mei_dev_state_str(dev->dev_state));
 226                 goto end_unlock;
 227         }
 228
 229         if (dev->wd_cl.state != MEI_FILE_CONNECTED)     {
 230                 dev_dbg(dev->dev, "MEI Driver is not connected to Watchdog Client\n");
 231                 goto end_unlock;
 232         }
 233
 234         mei_wd_set_start_timeout(dev, dev->wd_timeout);
 235
 236         err = 0;
 237 end_unlock:
 238         mutex_unlock(&dev->device_lock);
 239         return err;
 240 }
 241
 242 /*
 243  * mei_wd_ops_stop -  wd stop command from the watchdog core.
 244  *
 245  * @wd_dev - watchdog device struct
 246  *
 247  * Return: 0 if success, negative errno code for failure
 248  */
 249 static int mei_wd_ops_stop(struct watchdog_device *wd_dev)
 250 {
 251         struct mei_device *dev;
 252
 253         dev = watchdog_get_drvdata(wd_dev);
 254         if (!dev)
 255                 return -ENODEV;
 256
 257         mutex_lock(&dev->device_lock);
 258         mei_wd_stop(dev);
 259         mutex_unlock(&dev->device_lock);
 260
 261         return 0;
 262 }
 263
 264 /*
 265  * mei_wd_ops_ping - wd ping command from the watchdog core.
 266  *
 267  * @wd_dev - watchdog device struct
 268  *
 269  * Return: 0 if success, negative errno code for failure
 270  */
 271 static int mei_wd_ops_ping(struct watchdog_device *wd_dev)
 272 {
 273         struct mei_device *dev;
 274         struct mei_cl *cl;
 275         int ret;
 276
 277         dev = watchdog_get_drvdata(wd_dev);
 278         if (!dev)
 279                 return -ENODEV;
 280
 281         cl = &dev->wd_cl;
 282
 283         mutex_lock(&dev->device_lock);
 284
 285         if (cl->state != MEI_FILE_CONNECTED) {
 286                 dev_err(dev->dev, "wd: not connected.\n");
 287                 ret = -ENODEV;
 288                 goto end;
 289         }
 290
 291         dev->wd_state = MEI_WD_RUNNING;
 292
 293         ret = mei_cl_flow_ctrl_creds(cl);
 294         if (ret < 0)
 295                 goto end;
 296
 297         /* Check if we can send the ping to HW*/
 298         if (ret && mei_hbuf_acquire(dev)) {
 299                 dev_dbg(dev->dev, "wd: sending ping\n");
 300
 301                 ret = mei_wd_send(dev);
 302                 if (ret)
 303                         goto end;
 304                 dev->wd_pending = false;
 305         } else {
 306                 dev->wd_pending = true;
 307         }
 308
 309 end:
 310         mutex_unlock(&dev->device_lock);
 311         return ret;
 312 }
 313
 314 /*
 315  * mei_wd_ops_set_timeout - wd set timeout command from the watchdog core.
 316  *
 317  * @wd_dev - watchdog device struct
 318  * @timeout - timeout value to set
 319  *
 320  * Return: 0 if success, negative errno code for failure
 321  */
 322 static int mei_wd_ops_set_timeout(struct watchdog_device *wd_dev,
 323                 unsigned int timeout)
 324 {
 325         struct mei_device *dev;
 326
 327         dev = watchdog_get_drvdata(wd_dev);
 328         if (!dev)
 329                 return -ENODEV;
 330
 331         /* Check Timeout value */
 332         if (timeout < MEI_WD_MIN_TIMEOUT || timeout > MEI_WD_MAX_TIMEOUT)
 333                 return -EINVAL;
 334
 335         mutex_lock(&dev->device_lock);
 336
 337         dev->wd_timeout = timeout;
 338         wd_dev->timeout = timeout;
 339         mei_wd_set_start_timeout(dev, dev->wd_timeout);
 340
 341         mutex_unlock(&dev->device_lock);
 342
 343         return 0;
 344 }
 345
 346 /*
 347  * Watchdog Device structs
 348  */
 349 static const struct watchdog_ops wd_ops = {
 350                 .owner = THIS_MODULE,
 351                 .start = mei_wd_ops_start,
 352                 .stop = mei_wd_ops_stop,
 353                 .ping = mei_wd_ops_ping,
 354                 .set_timeout = mei_wd_ops_set_timeout,
 355 };
 356 static const struct watchdog_info wd_info = {
 357                 .identity = INTEL_AMT_WATCHDOG_ID,
 358                 .options = WDIOF_KEEPALIVEPING |
 359                            WDIOF_SETTIMEOUT |
 360                            WDIOF_ALARMONLY,
 361 };
 362
 363 static struct watchdog_device amt_wd_dev = {
 364                 .info = &wd_info,
 365                 .ops = &wd_ops,
 366                 .timeout = MEI_WD_DEFAULT_TIMEOUT,
 367                 .min_timeout = MEI_WD_MIN_TIMEOUT,
 368                 .max_timeout = MEI_WD_MAX_TIMEOUT,
 369 };
 370
 371
 372 int mei_watchdog_register(struct mei_device *dev)
 373 {
 374
 375         int ret;
 376
 377         /* unlock to perserve correct locking order */
 378         mutex_unlock(&dev->device_lock);
 379         ret = watchdog_register_device(&amt_wd_dev);
 380         mutex_lock(&dev->device_lock);
 381         if (ret) {
 382                 dev_err(dev->dev, "wd: unable to register watchdog device = %d.\n",
 383                         ret);
 384                 return ret;
 385         }
 386
 387         dev_dbg(dev->dev, "wd: successfully register watchdog interface.\n");
 388         watchdog_set_drvdata(&amt_wd_dev, dev);
 389         return 0;
 390 }
 391
 392 void mei_watchdog_unregister(struct mei_device *dev)
 393 {
 394         if (watchdog_get_drvdata(&amt_wd_dev) == NULL)
 395                 return;
 396
 397         watchdog_set_drvdata(&amt_wd_dev, NULL);
 398         watchdog_unregister_device(&amt_wd_dev);
 399 }
 400