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