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/watchdog.h> 22 #include <linux/poll.h> 23 #include <linux/mei.h> 24 25 #include "mei_dev.h" 26 27 /* 28 * reference counting base function 29 */ 30 void mei_me_cl_init(struct mei_me_client *me_cl); 31 void mei_me_cl_put(struct mei_me_client *me_cl); 32 struct mei_me_client *mei_me_cl_get(struct mei_me_client *me_cl); 33 34 void mei_me_cl_add(struct mei_device *dev, struct mei_me_client *me_cl); 35 void mei_me_cl_del(struct mei_device *dev, struct mei_me_client *me_cl); 36 37 struct mei_me_client *mei_me_cl_by_uuid(struct mei_device *dev, 38 const uuid_le *uuid); 39 struct mei_me_client *mei_me_cl_by_id(struct mei_device *dev, u8 client_id); 40 struct mei_me_client *mei_me_cl_by_uuid_id(struct mei_device *dev, 41 const uuid_le *uuid, u8 client_id); 42 void mei_me_cl_rm_by_uuid(struct mei_device *dev, const uuid_le *uuid); 43 void mei_me_cl_rm_by_uuid_id(struct mei_device *dev, 44 const uuid_le *uuid, u8 id); 45 void mei_me_cl_rm_all(struct mei_device *dev); 46 47 /* 48 * MEI IO Functions 49 */ 50 struct mei_cl_cb *mei_io_cb_init(struct mei_cl *cl, enum mei_cb_file_ops type, 51 struct file *fp); 52 void mei_io_cb_free(struct mei_cl_cb *priv_cb); 53 int mei_io_cb_alloc_buf(struct mei_cl_cb *cb, size_t length); 54 55 56 /** 57 * mei_io_list_init - Sets up a queue list. 58 * 59 * @list: An instance cl callback structure 60 */ 61 static inline void mei_io_list_init(struct mei_cl_cb *list) 62 { 63 INIT_LIST_HEAD(&list->list); 64 } 65 void mei_io_list_flush(struct mei_cl_cb *list, struct mei_cl *cl); 66 67 /* 68 * MEI Host Client Functions 69 */ 70 71 struct mei_cl *mei_cl_allocate(struct mei_device *dev); 72 void mei_cl_init(struct mei_cl *cl, struct mei_device *dev); 73 74 75 int mei_cl_link(struct mei_cl *cl, int id); 76 int mei_cl_unlink(struct mei_cl *cl); 77 78 struct mei_cl *mei_cl_alloc_linked(struct mei_device *dev, int id); 79 80 struct mei_cl_cb *mei_cl_read_cb(const struct mei_cl *cl, 81 const struct file *fp); 82 void mei_cl_read_cb_flush(const struct mei_cl *cl, const struct file *fp); 83 struct mei_cl_cb *mei_cl_alloc_cb(struct mei_cl *cl, size_t length, 84 enum mei_cb_file_ops type, struct file *fp); 85 int mei_cl_flush_queues(struct mei_cl *cl, const struct file *fp); 86 87 int mei_cl_flow_ctrl_creds(struct mei_cl *cl); 88 89 int mei_cl_flow_ctrl_reduce(struct mei_cl *cl); 90 /* 91 * MEI input output function prototype 92 */ 93 94 /** 95 * mei_cl_is_connected - host client is connected 96 * 97 * @cl: host clinet 98 * 99 * Return: true if the host clinet is connected 100 */ 101 static inline bool mei_cl_is_connected(struct mei_cl *cl) 102 { 103 return cl->state == MEI_FILE_CONNECTED; 104 } 105 106 bool mei_cl_is_other_connecting(struct mei_cl *cl); 107 int mei_cl_disconnect(struct mei_cl *cl); 108 int mei_cl_connect(struct mei_cl *cl, struct file *file); 109 int mei_cl_read_start(struct mei_cl *cl, size_t length, struct file *fp); 110 int mei_cl_irq_read_msg(struct mei_cl *cl, struct mei_msg_hdr *hdr, 111 struct mei_cl_cb *cmpl_list); 112 int mei_cl_write(struct mei_cl *cl, struct mei_cl_cb *cb, bool blocking); 113 int mei_cl_irq_write(struct mei_cl *cl, struct mei_cl_cb *cb, 114 struct mei_cl_cb *cmpl_list); 115 116 void mei_cl_complete(struct mei_cl *cl, struct mei_cl_cb *cb); 117 118 void mei_host_client_init(struct work_struct *work); 119 120 121 122 void mei_cl_all_disconnect(struct mei_device *dev); 123 void mei_cl_all_wakeup(struct mei_device *dev); 124 void mei_cl_all_write_clear(struct mei_device *dev); 125 126 #define MEI_CL_FMT "cl:host=%02d me=%02d " 127 #define MEI_CL_PRM(cl) (cl)->host_client_id, (cl)->me_client_id 128 129 #define cl_dbg(dev, cl, format, arg...) \ 130 dev_dbg((dev)->dev, MEI_CL_FMT format, MEI_CL_PRM(cl), ##arg) 131 132 #define cl_err(dev, cl, format, arg...) \ 133 dev_err((dev)->dev, MEI_CL_FMT format, MEI_CL_PRM(cl), ##arg) 134 135 #endif /* _MEI_CLIENT_H_ */ 136