drivers/staging/greybus/operation.h

/*
 * Greybus operations
 *
 * Copyright 2014 Google Inc.
 *
 * Released under the GPLv2 only.
 */

#ifndef __OPERATION_H
#define __OPERATION_H

#include <linux/completion.h>

enum gb_operation_status {
	GB_OP_SUCCESS		= 0,
	GB_OP_INVALID		= 1,
	GB_OP_NO_MEMORY		= 2,
	GB_OP_INTERRUPTED	= 3,
	GB_OP_RETRY		= 4,
	GB_OP_PROTOCOL_BAD	= 5,
	GB_OP_TIMEOUT		= 0xff,
};

/*
 * A Greybus operation is a remote procedure call performed over a
 * connection between the AP and a function on Greybus module.
 * Every operation consists of a request message sent to the other
 * end of the connection coupled with a reply returned to the
 * sender.
 *
 * The state for managing active requests on a connection is held in
 * the connection structure.
 *
 * YADA YADA
 *
 * submitting each request and providing its matching response to
 * the caller when it arrives.  Operations normally complete
 * asynchronously, and when an operation's response arrives its
 * callback function is executed.  The callback pointer is supplied
 * at the time the operation is submitted; a null callback pointer
 * causes synchronous operation--the caller is blocked until
 * the response arrives.  In addition, it is possible to await
 * the completion of a submitted asynchronous operation.
 *
 * A Greybus device operation includes a Greybus buffer to hold the
 * data sent to the device.  The only field within a Greybus
 * operation that should be used by a caller is the payload pointer,
 * which should be used to populate the request data.  This pointer
 * is guaranteed to be 64-bit aligned.
 * XXX and callback?
 */
struct gb_operation;
typedef void (*gb_operation_callback)(struct gb_operation *);
struct gb_operation {
	struct gb_connection	*connection;
	struct gbuf		*request;
	struct gbuf		*response;
	u16			id;
	bool			canceled;

	u8			result;
	struct work_struct	recv_work;
	gb_operation_callback	callback;	/* If asynchronous */
	struct completion	completion;	/* Used if no callback */
	struct delayed_work	timeout_work;

	struct list_head	links;		/* connection->operations */
	struct rb_node		node;		/* connection->pending */

	/* These are what's used by caller */
	void			*request_payload;
	void			*response_payload;
};

void gb_connection_operation_recv(struct gb_connection *connection,
					void *data, size_t size);

struct gb_operation *gb_operation_create(struct gb_connection *connection,
					u8 type, size_t request_size,
					size_t response_size);
void gb_operation_destroy(struct gb_operation *operation);

int gb_operation_request_send(struct gb_operation *operation,
				gb_operation_callback callback);
int gb_operation_response_send(struct gb_operation *operation);

void gb_operation_cancel(struct gb_operation *operation);
int gb_operation_wait(struct gb_operation *operation);

int gb_operation_init(void);
void gb_operation_exit(void);

#endif /* !__OPERATION_H */