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 /** 972dd1e5aeSAlexander Usyskin * mei_me_cl_vt - return me client vtag supported status 982dd1e5aeSAlexander Usyskin * 992dd1e5aeSAlexander Usyskin * @me_cl: me client 1002dd1e5aeSAlexander Usyskin * 1012dd1e5aeSAlexander Usyskin * Return: true if me client supports vt tagging 1022dd1e5aeSAlexander Usyskin */ 1032dd1e5aeSAlexander Usyskin static inline bool mei_me_cl_vt(const struct mei_me_client *me_cl) 1042dd1e5aeSAlexander Usyskin { 1052dd1e5aeSAlexander Usyskin return me_cl->props.vt_supported == 1; 1062dd1e5aeSAlexander Usyskin } 1072dd1e5aeSAlexander Usyskin 1082dd1e5aeSAlexander Usyskin /** 10964498695SAlexander Usyskin * mei_me_cl_max_len - return me client max msg length 11064498695SAlexander Usyskin * 11164498695SAlexander Usyskin * @me_cl: me client 11264498695SAlexander Usyskin * 11364498695SAlexander Usyskin * Return: me client max msg length 11464498695SAlexander Usyskin */ 11564498695SAlexander Usyskin static inline u32 mei_me_cl_max_len(const struct mei_me_client *me_cl) 11664498695SAlexander Usyskin { 11764498695SAlexander Usyskin return me_cl->props.max_msg_length; 11864498695SAlexander Usyskin } 11964498695SAlexander Usyskin 12090e0b5f1STomas Winkler /* 12190e0b5f1STomas Winkler * MEI IO Functions 12290e0b5f1STomas Winkler */ 12390e0b5f1STomas Winkler void mei_io_cb_free(struct mei_cl_cb *priv_cb); 12490e0b5f1STomas Winkler 12590e0b5f1STomas Winkler /* 12690e0b5f1STomas Winkler * MEI Host Client Functions 12790e0b5f1STomas Winkler */ 12890e0b5f1STomas Winkler 12990e0b5f1STomas Winkler struct mei_cl *mei_cl_allocate(struct mei_device *dev); 13090e0b5f1STomas Winkler 1317851e008SAlexander Usyskin int mei_cl_link(struct mei_cl *cl); 13290e0b5f1STomas Winkler int mei_cl_unlink(struct mei_cl *cl); 13390e0b5f1STomas Winkler 1347851e008SAlexander Usyskin struct mei_cl *mei_cl_alloc_linked(struct mei_device *dev); 13503b8d341STomas Winkler 136d1376f3dSAlexander Usyskin struct mei_cl_cb *mei_cl_read_cb(struct mei_cl *cl, const struct file *fp); 137d1376f3dSAlexander Usyskin 138d1376f3dSAlexander Usyskin void mei_cl_add_rd_completed(struct mei_cl *cl, struct mei_cl_cb *cb); 139d1376f3dSAlexander Usyskin void mei_cl_del_rd_completed(struct mei_cl *cl, struct mei_cl_cb *cb); 140d1376f3dSAlexander Usyskin 141bca67d68STomas Winkler struct mei_cl_cb *mei_cl_alloc_cb(struct mei_cl *cl, size_t length, 142f23e2cc4STomas Winkler enum mei_cb_file_ops type, 143f23e2cc4STomas Winkler const struct file *fp); 1443030dc05STomas Winkler struct mei_cl_cb *mei_cl_enqueue_ctrl_wr_cb(struct mei_cl *cl, size_t length, 1453030dc05STomas Winkler enum mei_cb_file_ops type, 1463030dc05STomas Winkler const struct file *fp); 147a9bed610STomas Winkler int mei_cl_flush_queues(struct mei_cl *cl, const struct file *fp); 14890e0b5f1STomas Winkler 149f35fe5f4SAlexander Usyskin struct mei_cl_vtag *mei_cl_vtag_alloc(struct file *fp, u8 vtag); 150f35fe5f4SAlexander Usyskin const struct file *mei_cl_fp_by_vtag(const struct mei_cl *cl, u8 vtag); 151f35fe5f4SAlexander Usyskin int mei_cl_vt_support_check(const struct mei_cl *cl); 15290e0b5f1STomas Winkler /* 15390e0b5f1STomas Winkler * MEI input output function prototype 15490e0b5f1STomas Winkler */ 1556a84d63dSTomas Winkler 1566a84d63dSTomas Winkler /** 1576a84d63dSTomas Winkler * mei_cl_is_connected - host client is connected 1586a84d63dSTomas Winkler * 159d49ed64aSAlexander Usyskin * @cl: host client 1606a84d63dSTomas Winkler * 161d49ed64aSAlexander Usyskin * Return: true if the host client is connected 1626a84d63dSTomas Winkler */ 163b950ac1dSTomas Winkler static inline bool mei_cl_is_connected(struct mei_cl *cl) 164b950ac1dSTomas Winkler { 165ab3ae009STomas Winkler return cl->state == MEI_FILE_CONNECTED; 166b950ac1dSTomas Winkler } 167b950ac1dSTomas Winkler 168d49ed64aSAlexander Usyskin /** 169d49ed64aSAlexander Usyskin * mei_cl_me_id - me client id 170d49ed64aSAlexander Usyskin * 171d49ed64aSAlexander Usyskin * @cl: host client 172d49ed64aSAlexander Usyskin * 173d49ed64aSAlexander Usyskin * Return: me client id or 0 if client is not connected 174d49ed64aSAlexander Usyskin */ 175d49ed64aSAlexander Usyskin static inline u8 mei_cl_me_id(const struct mei_cl *cl) 176d49ed64aSAlexander Usyskin { 177d49ed64aSAlexander Usyskin return cl->me_cl ? cl->me_cl->client_id : 0; 178d49ed64aSAlexander Usyskin } 179d49ed64aSAlexander Usyskin 180d49ed64aSAlexander Usyskin /** 181d49ed64aSAlexander Usyskin * mei_cl_mtu - maximal message that client can send and receive 182d49ed64aSAlexander Usyskin * 183d49ed64aSAlexander Usyskin * @cl: host client 184d49ed64aSAlexander Usyskin * 185bcbc0b2eSAlexander Usyskin * Return: mtu or 0 if client is not connected 186d49ed64aSAlexander Usyskin */ 187d49ed64aSAlexander Usyskin static inline size_t mei_cl_mtu(const struct mei_cl *cl) 188d49ed64aSAlexander Usyskin { 189bcbc0b2eSAlexander Usyskin return cl->me_cl ? cl->me_cl->props.max_msg_length : 0; 190d49ed64aSAlexander Usyskin } 191d49ed64aSAlexander Usyskin 192d49ed64aSAlexander Usyskin /** 193d49ed64aSAlexander Usyskin * mei_cl_is_fixed_address - check whether the me client uses fixed address 194d49ed64aSAlexander Usyskin * 195d49ed64aSAlexander Usyskin * @cl: host client 196d49ed64aSAlexander Usyskin * 197d49ed64aSAlexander Usyskin * Return: true if the client is connected and it has fixed me address 198d49ed64aSAlexander Usyskin */ 199d49ed64aSAlexander Usyskin static inline bool mei_cl_is_fixed_address(const struct mei_cl *cl) 200d49ed64aSAlexander Usyskin { 201d49ed64aSAlexander Usyskin return cl->me_cl && cl->me_cl->props.fixed_address; 202d49ed64aSAlexander Usyskin } 203d49ed64aSAlexander Usyskin 204d49ed64aSAlexander Usyskin /** 205d49ed64aSAlexander Usyskin * mei_cl_is_single_recv_buf- check whether the me client 206d49ed64aSAlexander Usyskin * uses single receiving buffer 207d49ed64aSAlexander Usyskin * 208d49ed64aSAlexander Usyskin * @cl: host client 209d49ed64aSAlexander Usyskin * 210d49ed64aSAlexander Usyskin * Return: true if single_recv_buf == 1; 0 otherwise 211d49ed64aSAlexander Usyskin */ 212d49ed64aSAlexander Usyskin static inline bool mei_cl_is_single_recv_buf(const struct mei_cl *cl) 213d49ed64aSAlexander Usyskin { 214d49ed64aSAlexander Usyskin return cl->me_cl->props.single_recv_buf; 215d49ed64aSAlexander Usyskin } 216d49ed64aSAlexander Usyskin 217d49ed64aSAlexander Usyskin /** 218d49ed64aSAlexander Usyskin * mei_cl_uuid - client's uuid 219d49ed64aSAlexander Usyskin * 220d49ed64aSAlexander Usyskin * @cl: host client 221d49ed64aSAlexander Usyskin * 222d49ed64aSAlexander Usyskin * Return: return uuid of connected me client 223d49ed64aSAlexander Usyskin */ 224d49ed64aSAlexander Usyskin static inline const uuid_le *mei_cl_uuid(const struct mei_cl *cl) 225d49ed64aSAlexander Usyskin { 226d49ed64aSAlexander Usyskin return mei_me_cl_uuid(cl->me_cl); 227d49ed64aSAlexander Usyskin } 228d49ed64aSAlexander Usyskin 2291df629efSAlexander Usyskin /** 2301df629efSAlexander Usyskin * mei_cl_host_addr - client's host address 2311df629efSAlexander Usyskin * 2321df629efSAlexander Usyskin * @cl: host client 2331df629efSAlexander Usyskin * 2341df629efSAlexander Usyskin * Return: 0 for fixed address client, host address for dynamic client 2351df629efSAlexander Usyskin */ 2361df629efSAlexander Usyskin static inline u8 mei_cl_host_addr(const struct mei_cl *cl) 2371df629efSAlexander Usyskin { 2381df629efSAlexander Usyskin return mei_cl_is_fixed_address(cl) ? 0 : cl->host_client_id; 2391df629efSAlexander Usyskin } 2401df629efSAlexander Usyskin 24190e0b5f1STomas Winkler int mei_cl_disconnect(struct mei_cl *cl); 2423c666182STomas Winkler int mei_cl_irq_disconnect(struct mei_cl *cl, struct mei_cl_cb *cb, 243962ff7bcSAlexander Usyskin struct list_head *cmpl_list); 244d49ed64aSAlexander Usyskin int mei_cl_connect(struct mei_cl *cl, struct mei_me_client *me_cl, 245f23e2cc4STomas Winkler const struct file *file); 2460c53357cSTomas Winkler int mei_cl_irq_connect(struct mei_cl *cl, struct mei_cl_cb *cb, 247962ff7bcSAlexander Usyskin struct list_head *cmpl_list); 248f23e2cc4STomas Winkler int mei_cl_read_start(struct mei_cl *cl, size_t length, const struct file *fp); 2495151e2b5STomas Winkler ssize_t mei_cl_write(struct mei_cl *cl, struct mei_cl_cb *cb); 2509d098192STomas Winkler int mei_cl_irq_write(struct mei_cl *cl, struct mei_cl_cb *cb, 251962ff7bcSAlexander Usyskin struct list_head *cmpl_list); 25221767546STomas Winkler 253db086fa9STomas Winkler void mei_cl_complete(struct mei_cl *cl, struct mei_cl_cb *cb); 25490e0b5f1STomas Winkler 255025fb792SAlexander Usyskin void mei_host_client_init(struct mei_device *dev); 25690e0b5f1STomas Winkler 25751678ccbSTomas Winkler u8 mei_cl_notify_fop2req(enum mei_cb_file_ops fop); 25851678ccbSTomas Winkler enum mei_cb_file_ops mei_cl_notify_req2fop(u8 request); 259f23e2cc4STomas Winkler int mei_cl_notify_request(struct mei_cl *cl, 260f23e2cc4STomas Winkler const struct file *file, u8 request); 26151678ccbSTomas Winkler int mei_cl_irq_notify(struct mei_cl *cl, struct mei_cl_cb *cb, 262962ff7bcSAlexander Usyskin struct list_head *cmpl_list); 263b38a362fSTomas Winkler int mei_cl_notify_get(struct mei_cl *cl, bool block, bool *notify_ev); 264237092bfSTomas Winkler void mei_cl_notify(struct mei_cl *cl); 26551678ccbSTomas Winkler 266074b4c01STomas Winkler void mei_cl_all_disconnect(struct mei_device *dev); 267074b4c01STomas Winkler 268c0abffbdSAlexander Usyskin #define MEI_CL_FMT "cl:host=%02d me=%02d " 269d49ed64aSAlexander Usyskin #define MEI_CL_PRM(cl) (cl)->host_client_id, mei_cl_me_id(cl) 270c0abffbdSAlexander Usyskin 271c0abffbdSAlexander Usyskin #define cl_dbg(dev, cl, format, arg...) \ 2722bf94cabSTomas Winkler dev_dbg((dev)->dev, MEI_CL_FMT format, MEI_CL_PRM(cl), ##arg) 273c0abffbdSAlexander Usyskin 2746938c192SAlexander Usyskin #define cl_warn(dev, cl, format, arg...) \ 2756938c192SAlexander Usyskin dev_warn((dev)->dev, MEI_CL_FMT format, MEI_CL_PRM(cl), ##arg) 2766938c192SAlexander Usyskin 277c0abffbdSAlexander Usyskin #define cl_err(dev, cl, format, arg...) \ 2782bf94cabSTomas Winkler dev_err((dev)->dev, MEI_CL_FMT format, MEI_CL_PRM(cl), ##arg) 279c0abffbdSAlexander Usyskin 28090e0b5f1STomas Winkler #endif /* _MEI_CLIENT_H_ */ 281