client.h 6.4 KB
Newer Older
T
Tomas Winkler 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
/*
 *
 * Intel Management Engine Interface (Intel MEI) Linux driver
 * Copyright (c) 2003-2012, Intel Corporation.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms and conditions of the GNU General Public License,
 * version 2, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 *
 */

#ifndef _MEI_CLIENT_H_
#define _MEI_CLIENT_H_

#include <linux/types.h>
#include <linux/poll.h>
#include <linux/mei.h>

#include "mei_dev.h"

26 27 28 29 30 31 32
/*
 * reference counting base function
 */
void mei_me_cl_init(struct mei_me_client *me_cl);
void mei_me_cl_put(struct mei_me_client *me_cl);
struct mei_me_client *mei_me_cl_get(struct mei_me_client *me_cl);

33 34 35 36
void mei_me_cl_add(struct mei_device *dev, struct mei_me_client *me_cl);
void mei_me_cl_del(struct mei_device *dev, struct mei_me_client *me_cl);

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 40
struct mei_me_client *mei_me_cl_by_uuid_id(struct mei_device *dev,
					   const uuid_le *uuid, u8 client_id);
41 42 43 44
void mei_me_cl_rm_by_uuid(struct mei_device *dev, const uuid_le *uuid);
void mei_me_cl_rm_by_uuid_id(struct mei_device *dev,
			     const uuid_le *uuid, u8 id);
void mei_me_cl_rm_all(struct mei_device *dev);
T
Tomas Winkler 已提交
45

46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
/**
 * mei_me_cl_is_active - check whether me client is active in the fw
 *
 * @me_cl: me client
 *
 * Return: true if the me client is active in the firmware
 */
static inline bool mei_me_cl_is_active(const struct mei_me_client *me_cl)
{
	return !list_empty_careful(&me_cl->list);
}

/**
 * mei_me_cl_uuid - return me client protocol name (uuid)
 *
 * @me_cl: me client
 *
 * Return: me client protocol name
 */
static inline const uuid_le *mei_me_cl_uuid(const struct mei_me_client *me_cl)
{
	return &me_cl->props.protocol_name;
}

70 71 72 73 74 75 76 77 78 79 80 81
/**
 * mei_me_cl_ver - return me client protocol version
 *
 * @me_cl: me client
 *
 * Return: me client protocol version
 */
static inline u8 mei_me_cl_ver(const struct mei_me_client *me_cl)
{
	return me_cl->props.protocol_version;
}

T
Tomas Winkler 已提交
82 83 84 85 86 87 88 89 90 91 92
/*
 * MEI IO Functions
 */
void mei_io_cb_free(struct mei_cl_cb *priv_cb);

/*
 * MEI Host Client Functions
 */

struct mei_cl *mei_cl_allocate(struct mei_device *dev);

93
int mei_cl_link(struct mei_cl *cl);
T
Tomas Winkler 已提交
94 95
int mei_cl_unlink(struct mei_cl *cl);

96
struct mei_cl *mei_cl_alloc_linked(struct mei_device *dev);
97

T
Tomas Winkler 已提交
98 99
struct mei_cl_cb *mei_cl_read_cb(const struct mei_cl *cl,
				 const struct file *fp);
100
struct mei_cl_cb *mei_cl_alloc_cb(struct mei_cl *cl, size_t length,
101 102
				  enum mei_cb_file_ops type,
				  const struct file *fp);
103 104 105
struct mei_cl_cb *mei_cl_enqueue_ctrl_wr_cb(struct mei_cl *cl, size_t length,
					    enum mei_cb_file_ops type,
					    const struct file *fp);
T
Tomas Winkler 已提交
106
int mei_cl_flush_queues(struct mei_cl *cl, const struct file *fp);
T
Tomas Winkler 已提交
107 108 109 110

/*
 *  MEI input output function prototype
 */
111 112 113 114

/**
 * mei_cl_is_connected - host client is connected
 *
115
 * @cl: host client
116
 *
117
 * Return: true if the host client is connected
118
 */
119 120
static inline bool mei_cl_is_connected(struct mei_cl *cl)
{
121
	return  cl->state == MEI_FILE_CONNECTED;
122 123
}

124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184
/**
 * mei_cl_me_id - me client id
 *
 * @cl: host client
 *
 * Return: me client id or 0 if client is not connected
 */
static inline u8 mei_cl_me_id(const struct mei_cl *cl)
{
	return cl->me_cl ? cl->me_cl->client_id : 0;
}

/**
 * mei_cl_mtu - maximal message that client can send and receive
 *
 * @cl: host client
 *
 * Return: mtu
 */
static inline size_t mei_cl_mtu(const struct mei_cl *cl)
{
	return cl->me_cl->props.max_msg_length;
}

/**
 * mei_cl_is_fixed_address - check whether the me client uses fixed address
 *
 * @cl: host client
 *
 * Return: true if the client is connected and it has fixed me address
 */
static inline bool mei_cl_is_fixed_address(const struct mei_cl *cl)
{
	return cl->me_cl && cl->me_cl->props.fixed_address;
}

/**
 * mei_cl_is_single_recv_buf- check whether the me client
 *       uses single receiving buffer
 *
 * @cl: host client
 *
 * Return: true if single_recv_buf == 1; 0 otherwise
 */
static inline bool mei_cl_is_single_recv_buf(const struct mei_cl *cl)
{
	return cl->me_cl->props.single_recv_buf;
}

/**
 * mei_cl_uuid -  client's uuid
 *
 * @cl: host client
 *
 * Return: return uuid of connected me client
 */
static inline const uuid_le *mei_cl_uuid(const struct mei_cl *cl)
{
	return mei_me_cl_uuid(cl->me_cl);
}

185 186 187 188 189 190 191 192 193 194 195 196
/**
 * mei_cl_host_addr - client's host address
 *
 * @cl: host client
 *
 * Return: 0 for fixed address client, host address for dynamic client
 */
static inline u8 mei_cl_host_addr(const struct mei_cl *cl)
{
	return  mei_cl_is_fixed_address(cl) ? 0 : cl->host_client_id;
}

T
Tomas Winkler 已提交
197
int mei_cl_disconnect(struct mei_cl *cl);
198
int mei_cl_irq_disconnect(struct mei_cl *cl, struct mei_cl_cb *cb,
199
			  struct list_head *cmpl_list);
200
int mei_cl_connect(struct mei_cl *cl, struct mei_me_client *me_cl,
201
		   const struct file *file);
T
Tomas Winkler 已提交
202
int mei_cl_irq_connect(struct mei_cl *cl, struct mei_cl_cb *cb,
203
		       struct list_head *cmpl_list);
204
int mei_cl_read_start(struct mei_cl *cl, size_t length, const struct file *fp);
205
int mei_cl_write(struct mei_cl *cl, struct mei_cl_cb *cb);
206
int mei_cl_irq_write(struct mei_cl *cl, struct mei_cl_cb *cb,
207
		     struct list_head *cmpl_list);
208

209
void mei_cl_complete(struct mei_cl *cl, struct mei_cl_cb *cb);
T
Tomas Winkler 已提交
210

211
void mei_host_client_init(struct mei_device *dev);
T
Tomas Winkler 已提交
212

213 214
u8 mei_cl_notify_fop2req(enum mei_cb_file_ops fop);
enum mei_cb_file_ops mei_cl_notify_req2fop(u8 request);
215 216
int mei_cl_notify_request(struct mei_cl *cl,
			  const struct file *file, u8 request);
217
int mei_cl_irq_notify(struct mei_cl *cl, struct mei_cl_cb *cb,
218
		      struct list_head *cmpl_list);
219
int mei_cl_notify_get(struct mei_cl *cl, bool block, bool *notify_ev);
220
void mei_cl_notify(struct mei_cl *cl);
221

222 223
void mei_cl_all_disconnect(struct mei_device *dev);

224
#define MEI_CL_FMT "cl:host=%02d me=%02d "
225
#define MEI_CL_PRM(cl) (cl)->host_client_id, mei_cl_me_id(cl)
226 227

#define cl_dbg(dev, cl, format, arg...) \
228
	dev_dbg((dev)->dev, MEI_CL_FMT format, MEI_CL_PRM(cl), ##arg)
229

230 231 232
#define cl_warn(dev, cl, format, arg...) \
	dev_warn((dev)->dev, MEI_CL_FMT format, MEI_CL_PRM(cl), ##arg)

233
#define cl_err(dev, cl, format, arg...) \
234
	dev_err((dev)->dev, MEI_CL_FMT format, MEI_CL_PRM(cl), ##arg)
235

T
Tomas Winkler 已提交
236
#endif /* _MEI_CLIENT_H_ */