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 struct mei_cl_cb *mei_io_cb_init(struct mei_cl *cl, enum mei_cb_file_ops type,
  86                                  const struct file *fp);
  87 void mei_io_cb_free(struct mei_cl_cb *priv_cb);
  88
  89 /**
  90  * mei_io_list_init - Sets up a queue list.
  91  *
  92  * @list: An instance cl callback structure
  93  */
  94 static inline void mei_io_list_init(struct mei_cl_cb *list)
  95 {
  96         INIT_LIST_HEAD(&list->list);
  97 }
  98 void mei_io_list_flush(struct mei_cl_cb *list, struct mei_cl *cl);
  99
 100 /*
 101  * MEI Host Client Functions
 102  */
 103
 104 struct mei_cl *mei_cl_allocate(struct mei_device *dev);
 105 void mei_cl_init(struct mei_cl *cl, struct mei_device *dev);
 106
 107
 108 int mei_cl_link(struct mei_cl *cl);
 109 int mei_cl_unlink(struct mei_cl *cl);
 110
 111 struct mei_cl *mei_cl_alloc_linked(struct mei_device *dev);
 112
 113 struct mei_cl_cb *mei_cl_read_cb(const struct mei_cl *cl,
 114                                  const struct file *fp);
 115 void mei_cl_read_cb_flush(const struct mei_cl *cl, const struct file *fp);
 116 struct mei_cl_cb *mei_cl_alloc_cb(struct mei_cl *cl, size_t length,
 117                                   enum mei_cb_file_ops type,
 118                                   const struct file *fp);
 119 int mei_cl_flush_queues(struct mei_cl *cl, const struct file *fp);
 120
 121 /*
 122  *  MEI input output function prototype
 123  */
 124
 125 /**
 126  * mei_cl_is_connected - host client is connected
 127  *
 128  * @cl: host client
 129  *
 130  * Return: true if the host client is connected
 131  */
 132 static inline bool mei_cl_is_connected(struct mei_cl *cl)
 133 {
 134         return  cl->state == MEI_FILE_CONNECTED;
 135 }
 136
 137 /**
 138  * mei_cl_me_id - me client id
 139  *
 140  * @cl: host client
 141  *
 142  * Return: me client id or 0 if client is not connected
 143  */
 144 static inline u8 mei_cl_me_id(const struct mei_cl *cl)
 145 {
 146         return cl->me_cl ? cl->me_cl->client_id : 0;
 147 }
 148
 149 /**
 150  * mei_cl_mtu - maximal message that client can send and receive
 151  *
 152  * @cl: host client
 153  *
 154  * Return: mtu
 155  */
 156 static inline size_t mei_cl_mtu(const struct mei_cl *cl)
 157 {
 158         return cl->me_cl->props.max_msg_length;
 159 }
 160
 161 /**
 162  * mei_cl_is_fixed_address - check whether the me client uses fixed address
 163  *
 164  * @cl: host client
 165  *
 166  * Return: true if the client is connected and it has fixed me address
 167  */
 168 static inline bool mei_cl_is_fixed_address(const struct mei_cl *cl)
 169 {
 170         return cl->me_cl && cl->me_cl->props.fixed_address;
 171 }
 172
 173 /**
 174  * mei_cl_is_single_recv_buf- check whether the me client
 175  *       uses single receiving buffer
 176  *
 177  * @cl: host client
 178  *
 179  * Return: true if single_recv_buf == 1; 0 otherwise
 180  */
 181 static inline bool mei_cl_is_single_recv_buf(const struct mei_cl *cl)
 182 {
 183         return cl->me_cl->props.single_recv_buf;
 184 }
 185
 186 /**
 187  * mei_cl_uuid -  client's uuid
 188  *
 189  * @cl: host client
 190  *
 191  * Return: return uuid of connected me client
 192  */
 193 static inline const uuid_le *mei_cl_uuid(const struct mei_cl *cl)
 194 {
 195         return mei_me_cl_uuid(cl->me_cl);
 196 }
 197
 198 /**
 199  * mei_cl_host_addr - client's host address
 200  *
 201  * @cl: host client
 202  *
 203  * Return: 0 for fixed address client, host address for dynamic client
 204  */
 205 static inline u8 mei_cl_host_addr(const struct mei_cl *cl)
 206 {
 207         return  mei_cl_is_fixed_address(cl) ? 0 : cl->host_client_id;
 208 }
 209
 210 int mei_cl_disconnect(struct mei_cl *cl);
 211 void mei_cl_set_disconnected(struct mei_cl *cl);
 212 int mei_cl_irq_disconnect(struct mei_cl *cl, struct mei_cl_cb *cb,
 213                           struct mei_cl_cb *cmpl_list);
 214 int mei_cl_connect(struct mei_cl *cl, struct mei_me_client *me_cl,
 215                    const struct file *file);
 216 int mei_cl_irq_connect(struct mei_cl *cl, struct mei_cl_cb *cb,
 217                               struct mei_cl_cb *cmpl_list);
 218 int mei_cl_read_start(struct mei_cl *cl, size_t length, const struct file *fp);
 219 int mei_cl_irq_read_msg(struct mei_cl *cl, struct mei_msg_hdr *hdr,
 220                         struct mei_cl_cb *cmpl_list);
 221 int mei_cl_write(struct mei_cl *cl, struct mei_cl_cb *cb, bool blocking);
 222 int mei_cl_irq_write(struct mei_cl *cl, struct mei_cl_cb *cb,
 223                      struct mei_cl_cb *cmpl_list);
 224
 225 void mei_cl_complete(struct mei_cl *cl, struct mei_cl_cb *cb);
 226
 227 void mei_host_client_init(struct mei_device *dev);
 228
 229 u8 mei_cl_notify_fop2req(enum mei_cb_file_ops fop);
 230 enum mei_cb_file_ops mei_cl_notify_req2fop(u8 request);
 231 int mei_cl_notify_request(struct mei_cl *cl,
 232                           const struct file *file, u8 request);
 233 int mei_cl_irq_notify(struct mei_cl *cl, struct mei_cl_cb *cb,
 234                       struct mei_cl_cb *cmpl_list);
 235 int mei_cl_notify_get(struct mei_cl *cl, bool block, bool *notify_ev);
 236 void mei_cl_notify(struct mei_cl *cl);
 237
 238 void mei_cl_all_disconnect(struct mei_device *dev);
 239
 240 #define MEI_CL_FMT "cl:host=%02d me=%02d "
 241 #define MEI_CL_PRM(cl) (cl)->host_client_id, mei_cl_me_id(cl)
 242
 243 #define cl_dbg(dev, cl, format, arg...) \
 244         dev_dbg((dev)->dev, MEI_CL_FMT format, MEI_CL_PRM(cl), ##arg)
 245
 246 #define cl_warn(dev, cl, format, arg...) \
 247         dev_warn((dev)->dev, MEI_CL_FMT format, MEI_CL_PRM(cl), ##arg)
 248
 249 #define cl_err(dev, cl, format, arg...) \
 250         dev_err((dev)->dev, MEI_CL_FMT format, MEI_CL_PRM(cl), ##arg)
 251
 252 #endif /* _MEI_CLIENT_H_ */