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/poll.h>
  22 #include <linux/mei.h>
  23
  24 #include "mei_dev.h"
  25
  26 /*
  27  * reference counting base function
  28  */
  29 void mei_me_cl_init(struct mei_me_client *me_cl);
  30 void mei_me_cl_put(struct mei_me_client *me_cl);
  31 struct mei_me_client *mei_me_cl_get(struct mei_me_client *me_cl);
  32
  33 void mei_me_cl_add(struct mei_device *dev, struct mei_me_client *me_cl);
  34 void mei_me_cl_del(struct mei_device *dev, struct mei_me_client *me_cl);
  35
  36 struct mei_me_client *mei_me_cl_by_uuid(struct mei_device *dev,
  37                                         const uuid_le *uuid);
  38 struct mei_me_client *mei_me_cl_by_id(struct mei_device *dev, u8 client_id);
  39 struct mei_me_client *mei_me_cl_by_uuid_id(struct mei_device *dev,
  40                                            const uuid_le *uuid, u8 client_id);
  41 void mei_me_cl_rm_by_uuid(struct mei_device *dev, const uuid_le *uuid);
  42 void mei_me_cl_rm_by_uuid_id(struct mei_device *dev,
  43                              const uuid_le *uuid, u8 id);
  44 void mei_me_cl_rm_all(struct mei_device *dev);
  45
  46 /**
  47  * mei_me_cl_is_active - check whether me client is active in the fw
  48  *
  49  * @me_cl: me client
  50  *
  51  * Return: true if the me client is active in the firmware
  52  */
  53 static inline bool mei_me_cl_is_active(const struct mei_me_client *me_cl)
  54 {
  55         return !list_empty_careful(&me_cl->list);
  56 }
  57
  58 /**
  59  * mei_me_cl_uuid - return me client protocol name (uuid)
  60  *
  61  * @me_cl: me client
  62  *
  63  * Return: me client protocol name
  64  */
  65 static inline const uuid_le *mei_me_cl_uuid(const struct mei_me_client *me_cl)
  66 {
  67         return &me_cl->props.protocol_name;
  68 }
  69
  70 /**
  71  * mei_me_cl_ver - return me client protocol version
  72  *
  73  * @me_cl: me client
  74  *
  75  * Return: me client protocol version
  76  */
  77 static inline u8 mei_me_cl_ver(const struct mei_me_client *me_cl)
  78 {
  79         return me_cl->props.protocol_version;
  80 }
  81
  82 /*
  83  * MEI IO Functions
  84  */
  85 void mei_io_cb_free(struct mei_cl_cb *priv_cb);
  86
  87 /**
  88  * mei_io_list_init - Sets up a queue list.
  89  *
  90  * @list: An instance cl callback structure
  91  */
  92 static inline void mei_io_list_init(struct mei_cl_cb *list)
  93 {
  94         INIT_LIST_HEAD(&list->list);
  95 }
  96 void mei_io_list_flush(struct mei_cl_cb *list, struct mei_cl *cl);
  97
  98 /*
  99  * MEI Host Client Functions
 100  */
 101
 102 struct mei_cl *mei_cl_allocate(struct mei_device *dev);
 103 void mei_cl_init(struct mei_cl *cl, struct mei_device *dev);
 104
 105
 106 int mei_cl_link(struct mei_cl *cl);
 107 int mei_cl_unlink(struct mei_cl *cl);
 108
 109 struct mei_cl *mei_cl_alloc_linked(struct mei_device *dev);
 110
 111 struct mei_cl_cb *mei_cl_read_cb(const struct mei_cl *cl,
 112                                  const struct file *fp);
 113 void mei_cl_read_cb_flush(const struct mei_cl *cl, const struct file *fp);
 114 struct mei_cl_cb *mei_cl_alloc_cb(struct mei_cl *cl, size_t length,
 115                                   enum mei_cb_file_ops type,
 116                                   const struct file *fp);
 117 struct mei_cl_cb *mei_cl_enqueue_ctrl_wr_cb(struct mei_cl *cl, size_t length,
 118                                             enum mei_cb_file_ops type,
 119                                             const struct file *fp);
 120 int mei_cl_flush_queues(struct mei_cl *cl, const struct file *fp);
 121
 122 /*
 123  *  MEI input output function prototype
 124  */
 125
 126 /**
 127  * mei_cl_is_connected - host client is connected
 128  *
 129  * @cl: host client
 130  *
 131  * Return: true if the host client is connected
 132  */
 133 static inline bool mei_cl_is_connected(struct mei_cl *cl)
 134 {
 135         return  cl->state == MEI_FILE_CONNECTED;
 136 }
 137
 138 /**
 139  * mei_cl_me_id - me client id
 140  *
 141  * @cl: host client
 142  *
 143  * Return: me client id or 0 if client is not connected
 144  */
 145 static inline u8 mei_cl_me_id(const struct mei_cl *cl)
 146 {
 147         return cl->me_cl ? cl->me_cl->client_id : 0;
 148 }
 149
 150 /**
 151  * mei_cl_mtu - maximal message that client can send and receive
 152  *
 153  * @cl: host client
 154  *
 155  * Return: mtu
 156  */
 157 static inline size_t mei_cl_mtu(const struct mei_cl *cl)
 158 {
 159         return cl->me_cl->props.max_msg_length;
 160 }
 161
 162 /**
 163  * mei_cl_is_fixed_address - check whether the me client uses fixed address
 164  *
 165  * @cl: host client
 166  *
 167  * Return: true if the client is connected and it has fixed me address
 168  */
 169 static inline bool mei_cl_is_fixed_address(const struct mei_cl *cl)
 170 {
 171         return cl->me_cl && cl->me_cl->props.fixed_address;
 172 }
 173
 174 /**
 175  * mei_cl_is_single_recv_buf- check whether the me client
 176  *       uses single receiving buffer
 177  *
 178  * @cl: host client
 179  *
 180  * Return: true if single_recv_buf == 1; 0 otherwise
 181  */
 182 static inline bool mei_cl_is_single_recv_buf(const struct mei_cl *cl)
 183 {
 184         return cl->me_cl->props.single_recv_buf;
 185 }
 186
 187 /**
 188  * mei_cl_uuid -  client's uuid
 189  *
 190  * @cl: host client
 191  *
 192  * Return: return uuid of connected me client
 193  */
 194 static inline const uuid_le *mei_cl_uuid(const struct mei_cl *cl)
 195 {
 196         return mei_me_cl_uuid(cl->me_cl);
 197 }
 198
 199 /**
 200  * mei_cl_host_addr - client's host address
 201  *
 202  * @cl: host client
 203  *
 204  * Return: 0 for fixed address client, host address for dynamic client
 205  */
 206 static inline u8 mei_cl_host_addr(const struct mei_cl *cl)
 207 {
 208         return  mei_cl_is_fixed_address(cl) ? 0 : cl->host_client_id;
 209 }
 210
 211 int mei_cl_disconnect(struct mei_cl *cl);
 212 void mei_cl_set_disconnected(struct mei_cl *cl);
 213 int mei_cl_irq_disconnect(struct mei_cl *cl, struct mei_cl_cb *cb,
 214                           struct mei_cl_cb *cmpl_list);
 215 int mei_cl_connect(struct mei_cl *cl, struct mei_me_client *me_cl,
 216                    const struct file *file);
 217 int mei_cl_irq_connect(struct mei_cl *cl, struct mei_cl_cb *cb,
 218                               struct mei_cl_cb *cmpl_list);
 219 int mei_cl_read_start(struct mei_cl *cl, size_t length, const struct file *fp);
 220 int mei_cl_irq_read_msg(struct mei_cl *cl, struct mei_msg_hdr *hdr,
 221                         struct mei_cl_cb *cmpl_list);
 222 int mei_cl_write(struct mei_cl *cl, struct mei_cl_cb *cb, bool blocking);
 223 int mei_cl_irq_write(struct mei_cl *cl, struct mei_cl_cb *cb,
 224                      struct mei_cl_cb *cmpl_list);
 225
 226 void mei_cl_complete(struct mei_cl *cl, struct mei_cl_cb *cb);
 227
 228 void mei_host_client_init(struct mei_device *dev);
 229
 230 u8 mei_cl_notify_fop2req(enum mei_cb_file_ops fop);
 231 enum mei_cb_file_ops mei_cl_notify_req2fop(u8 request);
 232 int mei_cl_notify_request(struct mei_cl *cl,
 233                           const struct file *file, u8 request);
 234 int mei_cl_irq_notify(struct mei_cl *cl, struct mei_cl_cb *cb,
 235                       struct mei_cl_cb *cmpl_list);
 236 int mei_cl_notify_get(struct mei_cl *cl, bool block, bool *notify_ev);
 237 void mei_cl_notify(struct mei_cl *cl);
 238
 239 void mei_cl_all_disconnect(struct mei_device *dev);
 240
 241 #define MEI_CL_FMT "cl:host=%02d me=%02d "
 242 #define MEI_CL_PRM(cl) (cl)->host_client_id, mei_cl_me_id(cl)
 243
 244 #define cl_dbg(dev, cl, format, arg...) \
 245         dev_dbg((dev)->dev, MEI_CL_FMT format, MEI_CL_PRM(cl), ##arg)
 246
 247 #define cl_warn(dev, cl, format, arg...) \
 248         dev_warn((dev)->dev, MEI_CL_FMT format, MEI_CL_PRM(cl), ##arg)
 249
 250 #define cl_err(dev, cl, format, arg...) \
 251         dev_err((dev)->dev, MEI_CL_FMT format, MEI_CL_PRM(cl), ##arg)
 252
 253 #endif /* _MEI_CLIENT_H_ */