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 struct mei_me_client *mei_me_cl_by_uuid(const struct mei_device *dev, 28 const uuid_le *cuuid); 29 struct mei_me_client *mei_me_cl_by_id(struct mei_device *dev, u8 client_id); 30 31 struct mei_me_client *mei_me_cl_by_uuid_id(struct mei_device *dev, 32 const uuid_le *uuid, u8 client_id); 33 34 void mei_me_cl_remove(struct mei_device *dev, 35 const uuid_le *uuid, u8 client_id); 36 37 /* 38 * MEI IO Functions 39 */ 40 struct mei_cl_cb *mei_io_cb_init(struct mei_cl *cl, struct file *fp); 41 void mei_io_cb_free(struct mei_cl_cb *priv_cb); 42 int mei_io_cb_alloc_req_buf(struct mei_cl_cb *cb, size_t length); 43 int mei_io_cb_alloc_resp_buf(struct mei_cl_cb *cb, size_t length); 44 45 46 /** 47 * mei_io_list_init - Sets up a queue list. 48 * 49 * @list: An instance cl callback structure 50 */ 51 static inline void mei_io_list_init(struct mei_cl_cb *list) 52 { 53 INIT_LIST_HEAD(&list->list); 54 } 55 void mei_io_list_flush(struct mei_cl_cb *list, struct mei_cl *cl); 56 57 /* 58 * MEI Host Client Functions 59 */ 60 61 struct mei_cl *mei_cl_allocate(struct mei_device *dev); 62 void mei_cl_init(struct mei_cl *cl, struct mei_device *dev); 63 64 65 int mei_cl_link(struct mei_cl *cl, int id); 66 int mei_cl_unlink(struct mei_cl *cl); 67 68 int mei_cl_flush_queues(struct mei_cl *cl); 69 struct mei_cl_cb *mei_cl_find_read_cb(struct mei_cl *cl); 70 71 72 int mei_cl_flow_ctrl_creds(struct mei_cl *cl); 73 74 int mei_cl_flow_ctrl_reduce(struct mei_cl *cl); 75 /* 76 * MEI input output function prototype 77 */ 78 static inline bool mei_cl_is_connected(struct mei_cl *cl) 79 { 80 return cl->dev && 81 cl->dev->dev_state == MEI_DEV_ENABLED && 82 cl->state == MEI_FILE_CONNECTED; 83 } 84 static inline bool mei_cl_is_transitioning(struct mei_cl *cl) 85 { 86 return MEI_FILE_INITIALIZING == cl->state || 87 MEI_FILE_DISCONNECTED == cl->state || 88 MEI_FILE_DISCONNECTING == cl->state; 89 } 90 91 bool mei_cl_is_other_connecting(struct mei_cl *cl); 92 int mei_cl_disconnect(struct mei_cl *cl); 93 int mei_cl_connect(struct mei_cl *cl, struct file *file); 94 int mei_cl_read_start(struct mei_cl *cl, size_t length); 95 int mei_cl_write(struct mei_cl *cl, struct mei_cl_cb *cb, bool blocking); 96 int mei_cl_irq_write(struct mei_cl *cl, struct mei_cl_cb *cb, 97 struct mei_cl_cb *cmpl_list); 98 99 void mei_cl_complete(struct mei_cl *cl, struct mei_cl_cb *cb); 100 101 void mei_host_client_init(struct work_struct *work); 102 103 104 105 void mei_cl_all_disconnect(struct mei_device *dev); 106 void mei_cl_all_wakeup(struct mei_device *dev); 107 void mei_cl_all_write_clear(struct mei_device *dev); 108 109 #define MEI_CL_FMT "cl:host=%02d me=%02d " 110 #define MEI_CL_PRM(cl) (cl)->host_client_id, (cl)->me_client_id 111 112 #define cl_dbg(dev, cl, format, arg...) \ 113 dev_dbg((dev)->dev, MEI_CL_FMT format, MEI_CL_PRM(cl), ##arg) 114 115 #define cl_err(dev, cl, format, arg...) \ 116 dev_err((dev)->dev, MEI_CL_FMT format, MEI_CL_PRM(cl), ##arg) 117 118 #endif /* _MEI_CLIENT_H_ */ 119