79563db9dd
To support dynamic addition and removal of me clients we add reference counter. Update kdoc with locking requirements. Signed-off-by: Tomas Winkler <tomas.winkler@intel.com> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
125 lines
3.7 KiB
C
125 lines
3.7 KiB
C
/*
|
|
*
|
|
* 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/watchdog.h>
|
|
#include <linux/poll.h>
|
|
#include <linux/mei.h>
|
|
|
|
#include "mei_dev.h"
|
|
|
|
/*
|
|
* 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);
|
|
|
|
struct mei_me_client *mei_me_cl_by_uuid(const struct mei_device *dev,
|
|
const uuid_le *uuid);
|
|
struct mei_me_client *mei_me_cl_by_id(struct mei_device *dev, u8 client_id);
|
|
struct mei_me_client *mei_me_cl_by_uuid_id(struct mei_device *dev,
|
|
const uuid_le *uuid, u8 client_id);
|
|
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);
|
|
|
|
/*
|
|
* MEI IO Functions
|
|
*/
|
|
struct mei_cl_cb *mei_io_cb_init(struct mei_cl *cl, struct file *fp);
|
|
void mei_io_cb_free(struct mei_cl_cb *priv_cb);
|
|
int mei_io_cb_alloc_req_buf(struct mei_cl_cb *cb, size_t length);
|
|
int mei_io_cb_alloc_resp_buf(struct mei_cl_cb *cb, size_t length);
|
|
|
|
|
|
/**
|
|
* mei_io_list_init - Sets up a queue list.
|
|
*
|
|
* @list: An instance cl callback structure
|
|
*/
|
|
static inline void mei_io_list_init(struct mei_cl_cb *list)
|
|
{
|
|
INIT_LIST_HEAD(&list->list);
|
|
}
|
|
void mei_io_list_flush(struct mei_cl_cb *list, struct mei_cl *cl);
|
|
|
|
/*
|
|
* MEI Host Client Functions
|
|
*/
|
|
|
|
struct mei_cl *mei_cl_allocate(struct mei_device *dev);
|
|
void mei_cl_init(struct mei_cl *cl, struct mei_device *dev);
|
|
|
|
|
|
int mei_cl_link(struct mei_cl *cl, int id);
|
|
int mei_cl_unlink(struct mei_cl *cl);
|
|
|
|
int mei_cl_flush_queues(struct mei_cl *cl);
|
|
struct mei_cl_cb *mei_cl_find_read_cb(struct mei_cl *cl);
|
|
|
|
|
|
int mei_cl_flow_ctrl_creds(struct mei_cl *cl);
|
|
|
|
int mei_cl_flow_ctrl_reduce(struct mei_cl *cl);
|
|
/*
|
|
* MEI input output function prototype
|
|
*/
|
|
static inline bool mei_cl_is_connected(struct mei_cl *cl)
|
|
{
|
|
return cl->dev &&
|
|
cl->dev->dev_state == MEI_DEV_ENABLED &&
|
|
cl->state == MEI_FILE_CONNECTED;
|
|
}
|
|
static inline bool mei_cl_is_transitioning(struct mei_cl *cl)
|
|
{
|
|
return MEI_FILE_INITIALIZING == cl->state ||
|
|
MEI_FILE_DISCONNECTED == cl->state ||
|
|
MEI_FILE_DISCONNECTING == cl->state;
|
|
}
|
|
|
|
bool mei_cl_is_other_connecting(struct mei_cl *cl);
|
|
int mei_cl_disconnect(struct mei_cl *cl);
|
|
int mei_cl_connect(struct mei_cl *cl, struct file *file);
|
|
int mei_cl_read_start(struct mei_cl *cl, size_t length);
|
|
int mei_cl_write(struct mei_cl *cl, struct mei_cl_cb *cb, bool blocking);
|
|
int mei_cl_irq_write(struct mei_cl *cl, struct mei_cl_cb *cb,
|
|
struct mei_cl_cb *cmpl_list);
|
|
|
|
void mei_cl_complete(struct mei_cl *cl, struct mei_cl_cb *cb);
|
|
|
|
void mei_host_client_init(struct work_struct *work);
|
|
|
|
|
|
|
|
void mei_cl_all_disconnect(struct mei_device *dev);
|
|
void mei_cl_all_wakeup(struct mei_device *dev);
|
|
void mei_cl_all_write_clear(struct mei_device *dev);
|
|
|
|
#define MEI_CL_FMT "cl:host=%02d me=%02d "
|
|
#define MEI_CL_PRM(cl) (cl)->host_client_id, (cl)->me_client_id
|
|
|
|
#define cl_dbg(dev, cl, format, arg...) \
|
|
dev_dbg((dev)->dev, MEI_CL_FMT format, MEI_CL_PRM(cl), ##arg)
|
|
|
|
#define cl_err(dev, cl, format, arg...) \
|
|
dev_err((dev)->dev, MEI_CL_FMT format, MEI_CL_PRM(cl), ##arg)
|
|
|
|
#endif /* _MEI_CLIENT_H_ */
|