drivers/misc/mei/client.h

   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
  17 #ifndef _MEI_CLIENT_H_
  18 #define _MEI_CLIENT_H_
  19
  20 #include <linux/types.h>
  21 #include <linux/watchdog.h>
  22 #include <linux/poll.h>
  23 #include <linux/mei.h>
  24
  25 #include "mei_dev.h"
  26
  27 int mei_me_cl_by_uuid(const struct mei_device *dev, const uuid_le *cuuid);
  28 int mei_me_cl_by_id(struct mei_device *dev, u8 client_id);
  29
  30 /*
  31  * MEI IO Functions
  32  */
  33 struct mei_cl_cb *mei_io_cb_init(struct mei_cl *cl, struct file *fp);
  34 void mei_io_cb_free(struct mei_cl_cb *priv_cb);
  35 int mei_io_cb_alloc_req_buf(struct mei_cl_cb *cb, size_t length);
  36 int mei_io_cb_alloc_resp_buf(struct mei_cl_cb *cb, size_t length);
  37
  38
  39 /**
  40  * mei_io_list_init - Sets up a queue list.
  41  *
  42  * @list: An instance cl callback structure
  43  */
  44 static inline void mei_io_list_init(struct mei_cl_cb *list)
  45 {
  46         INIT_LIST_HEAD(&list->list);
  47 }
  48 void mei_io_list_flush(struct mei_cl_cb *list, struct mei_cl *cl);
  49
  50 /*
  51  * MEI Host Client Functions
  52  */
  53
  54 struct mei_cl *mei_cl_allocate(struct mei_device *dev);
  55 void mei_cl_init(struct mei_cl *cl, struct mei_device *dev);
  56
  57
  58 int mei_cl_link(struct mei_cl *cl, int id);
  59 int mei_cl_unlink(struct mei_cl *cl);
  60
  61 int mei_cl_flush_queues(struct mei_cl *cl);
  62 struct mei_cl_cb *mei_cl_find_read_cb(struct mei_cl *cl);
  63
  64 /**
  65  * mei_cl_cmp_id - tells if file private data have same id
  66  *
  67  * @fe1: private data of 1. file object
  68  * @fe2: private data of 2. file object
  69  *
  70  * returns true  - if ids are the same and not NULL
  71  */
  72 static inline bool mei_cl_cmp_id(const struct mei_cl *cl1,
  73                                 const struct mei_cl *cl2)
  74 {
  75         return cl1 && cl2 &&
  76                 (cl1->host_client_id == cl2->host_client_id) &&
  77                 (cl1->me_client_id == cl2->me_client_id);
  78 }
  79
  80
  81 int mei_cl_flow_ctrl_creds(struct mei_cl *cl);
  82
  83 int mei_cl_flow_ctrl_reduce(struct mei_cl *cl);
  84 /*
  85  *  MEI input output function prototype
  86  */
  87 static inline bool mei_cl_is_connected(struct mei_cl *cl)
  88 {
  89         return (cl->dev &&
  90                 cl->dev->dev_state == MEI_DEV_ENABLED &&
  91                 cl->state == MEI_FILE_CONNECTED);
  92 }
  93 static inline bool mei_cl_is_transitioning(struct mei_cl *cl)
  94 {
  95         return (MEI_FILE_INITIALIZING == cl->state ||
  96                 MEI_FILE_DISCONNECTED == cl->state ||
  97                 MEI_FILE_DISCONNECTING == cl->state);
  98 }
  99
 100 bool mei_cl_is_other_connecting(struct mei_cl *cl);
 101 int mei_cl_disconnect(struct mei_cl *cl);
 102 int mei_cl_connect(struct mei_cl *cl, struct file *file);
 103 int mei_cl_read_start(struct mei_cl *cl, size_t length);
 104 int mei_cl_write(struct mei_cl *cl, struct mei_cl_cb *cb, bool blocking);
 105 int mei_cl_irq_write_complete(struct mei_cl *cl, struct mei_cl_cb *cb,
 106                                 s32 *slots, struct mei_cl_cb *cmpl_list);
 107
 108 void mei_cl_complete(struct mei_cl *cl, struct mei_cl_cb *cb);
 109
 110 void mei_host_client_init(struct work_struct *work);
 111
 112
 113
 114 void mei_cl_all_disconnect(struct mei_device *dev);
 115 void mei_cl_all_wakeup(struct mei_device *dev);
 116 void mei_cl_all_write_clear(struct mei_device *dev);
 117
 118 #define MEI_CL_FMT "cl:host=%02d me=%02d "
 119 #define MEI_CL_PRM(cl) (cl)->host_client_id, (cl)->me_client_id
 120
 121 #define cl_dbg(dev, cl, format, arg...) \
 122         dev_dbg(&(dev)->pdev->dev, MEI_CL_FMT format, MEI_CL_PRM(cl), ##arg)
 123
 124 #define cl_err(dev, cl, format, arg...) \
 125         dev_err(&(dev)->pdev->dev, MEI_CL_FMT format, MEI_CL_PRM(cl), ##arg)
 126
 127 #endif /* _MEI_CLIENT_H_ */