drivers/misc/mei/client.h

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