19fff0425STomas Winkler /* SPDX-License-Identifier: GPL-2.0 */ 290e0b5f1STomas Winkler /* 31e55b609STomas Winkler * Copyright (c) 2003-2018, Intel Corporation. All rights reserved. 490e0b5f1STomas Winkler * Intel Management Engine Interface (Intel MEI) Linux driver 590e0b5f1STomas Winkler */ 690e0b5f1STomas Winkler 790e0b5f1STomas Winkler #ifndef _MEI_CLIENT_H_ 890e0b5f1STomas Winkler #define _MEI_CLIENT_H_ 990e0b5f1STomas Winkler 1090e0b5f1STomas Winkler #include <linux/types.h> 1190e0b5f1STomas Winkler #include <linux/poll.h> 1290e0b5f1STomas Winkler #include <linux/mei.h> 1390e0b5f1STomas Winkler 1490e0b5f1STomas Winkler #include "mei_dev.h" 1590e0b5f1STomas Winkler 1679563db9STomas Winkler /* 1779563db9STomas Winkler * reference counting base function 1879563db9STomas Winkler */ 1979563db9STomas Winkler void mei_me_cl_init(struct mei_me_client *me_cl); 2079563db9STomas Winkler void mei_me_cl_put(struct mei_me_client *me_cl); 2179563db9STomas Winkler struct mei_me_client *mei_me_cl_get(struct mei_me_client *me_cl); 22d880f329STomas Winkler 23b7d88514STomas Winkler void mei_me_cl_add(struct mei_device *dev, struct mei_me_client *me_cl); 24b7d88514STomas Winkler void mei_me_cl_del(struct mei_device *dev, struct mei_me_client *me_cl); 25b7d88514STomas Winkler 26b7d88514STomas Winkler struct mei_me_client *mei_me_cl_by_uuid(struct mei_device *dev, 2779563db9STomas Winkler const uuid_le *uuid); 2879563db9STomas Winkler struct mei_me_client *mei_me_cl_by_id(struct mei_device *dev, u8 client_id); 29d880f329STomas Winkler struct mei_me_client *mei_me_cl_by_uuid_id(struct mei_device *dev, 30d880f329STomas Winkler const uuid_le *uuid, u8 client_id); 3179563db9STomas Winkler void mei_me_cl_rm_by_uuid(struct mei_device *dev, const uuid_le *uuid); 3279563db9STomas Winkler void mei_me_cl_rm_by_uuid_id(struct mei_device *dev, 3379563db9STomas Winkler const uuid_le *uuid, u8 id); 3479563db9STomas Winkler void mei_me_cl_rm_all(struct mei_device *dev); 3590e0b5f1STomas Winkler 36d49ed64aSAlexander Usyskin /** 37d49ed64aSAlexander Usyskin * mei_me_cl_is_active - check whether me client is active in the fw 38d49ed64aSAlexander Usyskin * 39d49ed64aSAlexander Usyskin * @me_cl: me client 40d49ed64aSAlexander Usyskin * 41d49ed64aSAlexander Usyskin * Return: true if the me client is active in the firmware 42d49ed64aSAlexander Usyskin */ 43d49ed64aSAlexander Usyskin static inline bool mei_me_cl_is_active(const struct mei_me_client *me_cl) 44d49ed64aSAlexander Usyskin { 45d49ed64aSAlexander Usyskin return !list_empty_careful(&me_cl->list); 46d49ed64aSAlexander Usyskin } 47d49ed64aSAlexander Usyskin 48d49ed64aSAlexander Usyskin /** 49d49ed64aSAlexander Usyskin * mei_me_cl_uuid - return me client protocol name (uuid) 50d49ed64aSAlexander Usyskin * 51d49ed64aSAlexander Usyskin * @me_cl: me client 52d49ed64aSAlexander Usyskin * 53d49ed64aSAlexander Usyskin * Return: me client protocol name 54d49ed64aSAlexander Usyskin */ 55d49ed64aSAlexander Usyskin static inline const uuid_le *mei_me_cl_uuid(const struct mei_me_client *me_cl) 56d49ed64aSAlexander Usyskin { 57d49ed64aSAlexander Usyskin return &me_cl->props.protocol_name; 58d49ed64aSAlexander Usyskin } 59d49ed64aSAlexander Usyskin 6040b7320eSTomas Winkler /** 6140b7320eSTomas Winkler * mei_me_cl_ver - return me client protocol version 6240b7320eSTomas Winkler * 6340b7320eSTomas Winkler * @me_cl: me client 6440b7320eSTomas Winkler * 6540b7320eSTomas Winkler * Return: me client protocol version 6640b7320eSTomas Winkler */ 6740b7320eSTomas Winkler static inline u8 mei_me_cl_ver(const struct mei_me_client *me_cl) 6840b7320eSTomas Winkler { 6940b7320eSTomas Winkler return me_cl->props.protocol_version; 7040b7320eSTomas Winkler } 7140b7320eSTomas Winkler 7264498695SAlexander Usyskin /** 7364498695SAlexander Usyskin * mei_me_cl_max_conn - return me client max number of connections 7464498695SAlexander Usyskin * 7564498695SAlexander Usyskin * @me_cl: me client 7664498695SAlexander Usyskin * 7764498695SAlexander Usyskin * Return: me client max number of connections 7864498695SAlexander Usyskin */ 7964498695SAlexander Usyskin static inline u8 mei_me_cl_max_conn(const struct mei_me_client *me_cl) 8064498695SAlexander Usyskin { 8164498695SAlexander Usyskin return me_cl->props.max_number_of_connections; 8264498695SAlexander Usyskin } 8364498695SAlexander Usyskin 8464498695SAlexander Usyskin /** 8564498695SAlexander Usyskin * mei_me_cl_fixed - return me client fixed address, if any 8664498695SAlexander Usyskin * 8764498695SAlexander Usyskin * @me_cl: me client 8864498695SAlexander Usyskin * 8964498695SAlexander Usyskin * Return: me client fixed address 9064498695SAlexander Usyskin */ 9164498695SAlexander Usyskin static inline u8 mei_me_cl_fixed(const struct mei_me_client *me_cl) 9264498695SAlexander Usyskin { 9364498695SAlexander Usyskin return me_cl->props.fixed_address; 9464498695SAlexander Usyskin } 9564498695SAlexander Usyskin 9664498695SAlexander Usyskin /** 9764498695SAlexander Usyskin * mei_me_cl_max_len - return me client max msg length 9864498695SAlexander Usyskin * 9964498695SAlexander Usyskin * @me_cl: me client 10064498695SAlexander Usyskin * 10164498695SAlexander Usyskin * Return: me client max msg length 10264498695SAlexander Usyskin */ 10364498695SAlexander Usyskin static inline u32 mei_me_cl_max_len(const struct mei_me_client *me_cl) 10464498695SAlexander Usyskin { 10564498695SAlexander Usyskin return me_cl->props.max_msg_length; 10664498695SAlexander Usyskin } 10764498695SAlexander Usyskin 10890e0b5f1STomas Winkler /* 10990e0b5f1STomas Winkler * MEI IO Functions 11090e0b5f1STomas Winkler */ 11190e0b5f1STomas Winkler void mei_io_cb_free(struct mei_cl_cb *priv_cb); 11290e0b5f1STomas Winkler 11390e0b5f1STomas Winkler /* 11490e0b5f1STomas Winkler * MEI Host Client Functions 11590e0b5f1STomas Winkler */ 11690e0b5f1STomas Winkler 11790e0b5f1STomas Winkler struct mei_cl *mei_cl_allocate(struct mei_device *dev); 11890e0b5f1STomas Winkler 1197851e008SAlexander Usyskin int mei_cl_link(struct mei_cl *cl); 12090e0b5f1STomas Winkler int mei_cl_unlink(struct mei_cl *cl); 12190e0b5f1STomas Winkler 1227851e008SAlexander Usyskin struct mei_cl *mei_cl_alloc_linked(struct mei_device *dev); 12303b8d341STomas Winkler 124a9bed610STomas Winkler struct mei_cl_cb *mei_cl_read_cb(const struct mei_cl *cl, 125a9bed610STomas Winkler const struct file *fp); 126bca67d68STomas Winkler struct mei_cl_cb *mei_cl_alloc_cb(struct mei_cl *cl, size_t length, 127f23e2cc4STomas Winkler enum mei_cb_file_ops type, 128f23e2cc4STomas Winkler const struct file *fp); 1293030dc05STomas Winkler struct mei_cl_cb *mei_cl_enqueue_ctrl_wr_cb(struct mei_cl *cl, size_t length, 1303030dc05STomas Winkler enum mei_cb_file_ops type, 1313030dc05STomas Winkler const struct file *fp); 132a9bed610STomas Winkler int mei_cl_flush_queues(struct mei_cl *cl, const struct file *fp); 13390e0b5f1STomas Winkler 13490e0b5f1STomas Winkler /* 13590e0b5f1STomas Winkler * MEI input output function prototype 13690e0b5f1STomas Winkler */ 1376a84d63dSTomas Winkler 1386a84d63dSTomas Winkler /** 1396a84d63dSTomas Winkler * mei_cl_is_connected - host client is connected 1406a84d63dSTomas Winkler * 141d49ed64aSAlexander Usyskin * @cl: host client 1426a84d63dSTomas Winkler * 143d49ed64aSAlexander Usyskin * Return: true if the host client is connected 1446a84d63dSTomas Winkler */ 145b950ac1dSTomas Winkler static inline bool mei_cl_is_connected(struct mei_cl *cl) 146b950ac1dSTomas Winkler { 147ab3ae009STomas Winkler return cl->state == MEI_FILE_CONNECTED; 148b950ac1dSTomas Winkler } 149b950ac1dSTomas Winkler 150d49ed64aSAlexander Usyskin /** 151d49ed64aSAlexander Usyskin * mei_cl_me_id - me client id 152d49ed64aSAlexander Usyskin * 153d49ed64aSAlexander Usyskin * @cl: host client 154d49ed64aSAlexander Usyskin * 155d49ed64aSAlexander Usyskin * Return: me client id or 0 if client is not connected 156d49ed64aSAlexander Usyskin */ 157d49ed64aSAlexander Usyskin static inline u8 mei_cl_me_id(const struct mei_cl *cl) 158d49ed64aSAlexander Usyskin { 159d49ed64aSAlexander Usyskin return cl->me_cl ? cl->me_cl->client_id : 0; 160d49ed64aSAlexander Usyskin } 161d49ed64aSAlexander Usyskin 162d49ed64aSAlexander Usyskin /** 163d49ed64aSAlexander Usyskin * mei_cl_mtu - maximal message that client can send and receive 164d49ed64aSAlexander Usyskin * 165d49ed64aSAlexander Usyskin * @cl: host client 166d49ed64aSAlexander Usyskin * 167d49ed64aSAlexander Usyskin * Return: mtu 168d49ed64aSAlexander Usyskin */ 169d49ed64aSAlexander Usyskin static inline size_t mei_cl_mtu(const struct mei_cl *cl) 170d49ed64aSAlexander Usyskin { 171d49ed64aSAlexander Usyskin return cl->me_cl->props.max_msg_length; 172d49ed64aSAlexander Usyskin } 173d49ed64aSAlexander Usyskin 174d49ed64aSAlexander Usyskin /** 175d49ed64aSAlexander Usyskin * mei_cl_is_fixed_address - check whether the me client uses fixed address 176d49ed64aSAlexander Usyskin * 177d49ed64aSAlexander Usyskin * @cl: host client 178d49ed64aSAlexander Usyskin * 179d49ed64aSAlexander Usyskin * Return: true if the client is connected and it has fixed me address 180d49ed64aSAlexander Usyskin */ 181d49ed64aSAlexander Usyskin static inline bool mei_cl_is_fixed_address(const struct mei_cl *cl) 182d49ed64aSAlexander Usyskin { 183d49ed64aSAlexander Usyskin return cl->me_cl && cl->me_cl->props.fixed_address; 184d49ed64aSAlexander Usyskin } 185d49ed64aSAlexander Usyskin 186d49ed64aSAlexander Usyskin /** 187d49ed64aSAlexander Usyskin * mei_cl_is_single_recv_buf- check whether the me client 188d49ed64aSAlexander Usyskin * uses single receiving buffer 189d49ed64aSAlexander Usyskin * 190d49ed64aSAlexander Usyskin * @cl: host client 191d49ed64aSAlexander Usyskin * 192d49ed64aSAlexander Usyskin * Return: true if single_recv_buf == 1; 0 otherwise 193d49ed64aSAlexander Usyskin */ 194d49ed64aSAlexander Usyskin static inline bool mei_cl_is_single_recv_buf(const struct mei_cl *cl) 195d49ed64aSAlexander Usyskin { 196d49ed64aSAlexander Usyskin return cl->me_cl->props.single_recv_buf; 197d49ed64aSAlexander Usyskin } 198d49ed64aSAlexander Usyskin 199d49ed64aSAlexander Usyskin /** 200d49ed64aSAlexander Usyskin * mei_cl_uuid - client's uuid 201d49ed64aSAlexander Usyskin * 202d49ed64aSAlexander Usyskin * @cl: host client 203d49ed64aSAlexander Usyskin * 204d49ed64aSAlexander Usyskin * Return: return uuid of connected me client 205d49ed64aSAlexander Usyskin */ 206d49ed64aSAlexander Usyskin static inline const uuid_le *mei_cl_uuid(const struct mei_cl *cl) 207d49ed64aSAlexander Usyskin { 208d49ed64aSAlexander Usyskin return mei_me_cl_uuid(cl->me_cl); 209d49ed64aSAlexander Usyskin } 210d49ed64aSAlexander Usyskin 2111df629efSAlexander Usyskin /** 2121df629efSAlexander Usyskin * mei_cl_host_addr - client's host address 2131df629efSAlexander Usyskin * 2141df629efSAlexander Usyskin * @cl: host client 2151df629efSAlexander Usyskin * 2161df629efSAlexander Usyskin * Return: 0 for fixed address client, host address for dynamic client 2171df629efSAlexander Usyskin */ 2181df629efSAlexander Usyskin static inline u8 mei_cl_host_addr(const struct mei_cl *cl) 2191df629efSAlexander Usyskin { 2201df629efSAlexander Usyskin return mei_cl_is_fixed_address(cl) ? 0 : cl->host_client_id; 2211df629efSAlexander Usyskin } 2221df629efSAlexander Usyskin 22390e0b5f1STomas Winkler int mei_cl_disconnect(struct mei_cl *cl); 2243c666182STomas Winkler int mei_cl_irq_disconnect(struct mei_cl *cl, struct mei_cl_cb *cb, 225962ff7bcSAlexander Usyskin struct list_head *cmpl_list); 226d49ed64aSAlexander Usyskin int mei_cl_connect(struct mei_cl *cl, struct mei_me_client *me_cl, 227f23e2cc4STomas Winkler const struct file *file); 2280c53357cSTomas Winkler int mei_cl_irq_connect(struct mei_cl *cl, struct mei_cl_cb *cb, 229962ff7bcSAlexander Usyskin struct list_head *cmpl_list); 230f23e2cc4STomas Winkler int mei_cl_read_start(struct mei_cl *cl, size_t length, const struct file *fp); 2315151e2b5STomas Winkler ssize_t mei_cl_write(struct mei_cl *cl, struct mei_cl_cb *cb); 2329d098192STomas Winkler int mei_cl_irq_write(struct mei_cl *cl, struct mei_cl_cb *cb, 233962ff7bcSAlexander Usyskin struct list_head *cmpl_list); 23421767546STomas Winkler 235db086fa9STomas Winkler void mei_cl_complete(struct mei_cl *cl, struct mei_cl_cb *cb); 23690e0b5f1STomas Winkler 237025fb792SAlexander Usyskin void mei_host_client_init(struct mei_device *dev); 23890e0b5f1STomas Winkler 23951678ccbSTomas Winkler u8 mei_cl_notify_fop2req(enum mei_cb_file_ops fop); 24051678ccbSTomas Winkler enum mei_cb_file_ops mei_cl_notify_req2fop(u8 request); 241f23e2cc4STomas Winkler int mei_cl_notify_request(struct mei_cl *cl, 242f23e2cc4STomas Winkler const struct file *file, u8 request); 24351678ccbSTomas Winkler int mei_cl_irq_notify(struct mei_cl *cl, struct mei_cl_cb *cb, 244962ff7bcSAlexander Usyskin struct list_head *cmpl_list); 245b38a362fSTomas Winkler int mei_cl_notify_get(struct mei_cl *cl, bool block, bool *notify_ev); 246237092bfSTomas Winkler void mei_cl_notify(struct mei_cl *cl); 24751678ccbSTomas Winkler 248074b4c01STomas Winkler void mei_cl_all_disconnect(struct mei_device *dev); 249074b4c01STomas Winkler 250c0abffbdSAlexander Usyskin #define MEI_CL_FMT "cl:host=%02d me=%02d " 251d49ed64aSAlexander Usyskin #define MEI_CL_PRM(cl) (cl)->host_client_id, mei_cl_me_id(cl) 252c0abffbdSAlexander Usyskin 253c0abffbdSAlexander Usyskin #define cl_dbg(dev, cl, format, arg...) \ 2542bf94cabSTomas Winkler dev_dbg((dev)->dev, MEI_CL_FMT format, MEI_CL_PRM(cl), ##arg) 255c0abffbdSAlexander Usyskin 2566938c192SAlexander Usyskin #define cl_warn(dev, cl, format, arg...) \ 2576938c192SAlexander Usyskin dev_warn((dev)->dev, MEI_CL_FMT format, MEI_CL_PRM(cl), ##arg) 2586938c192SAlexander Usyskin 259c0abffbdSAlexander Usyskin #define cl_err(dev, cl, format, arg...) \ 2602bf94cabSTomas Winkler dev_err((dev)->dev, MEI_CL_FMT format, MEI_CL_PRM(cl), ##arg) 261c0abffbdSAlexander Usyskin 26290e0b5f1STomas Winkler #endif /* _MEI_CLIENT_H_ */ 263