2014-10-02 02:54:15 +00:00
|
|
|
/*
|
|
|
|
* Greybus operations
|
|
|
|
*
|
|
|
|
* Copyright 2014 Google Inc.
|
|
|
|
*
|
|
|
|
* Released under the GPLv2 only.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#include <linux/kernel.h>
|
|
|
|
#include <linux/slab.h>
|
|
|
|
#include <linux/module.h>
|
|
|
|
#include <linux/workqueue.h>
|
|
|
|
|
|
|
|
#include "greybus.h"
|
|
|
|
|
2014-10-16 11:35:31 +00:00
|
|
|
/*
|
|
|
|
* The top bit of the type in an operation message header indicates
|
|
|
|
* whether the message is a request (bit clear) or response (bit set)
|
|
|
|
*/
|
|
|
|
#define GB_OPERATION_TYPE_RESPONSE 0x80
|
|
|
|
|
2014-10-16 11:35:33 +00:00
|
|
|
/*
|
|
|
|
* XXX This needs to be coordinated with host driver parameters
|
|
|
|
*/
|
|
|
|
#define GB_OPERATION_MESSAGE_SIZE_MAX 4096
|
|
|
|
|
2014-10-02 02:54:15 +00:00
|
|
|
/*
|
|
|
|
* All operation messages (both requests and responses) begin with
|
|
|
|
* a common header that encodes the size of the data (header
|
|
|
|
* included). This header also contains a unique identifier, which
|
|
|
|
* is used to keep track of in-flight operations. Finally, the
|
|
|
|
* header contains a operation type field, whose interpretation is
|
|
|
|
* dependent on what type of device lies on the other end of the
|
|
|
|
* connection. Response messages are distinguished from request
|
|
|
|
* messages by setting the high bit (0x80) in the operation type
|
|
|
|
* value.
|
|
|
|
*
|
|
|
|
* The wire format for all numeric fields in the header is little
|
|
|
|
* endian. Any operation-specific data begins immediately after the
|
|
|
|
* header, and is 64-bit aligned.
|
|
|
|
*/
|
|
|
|
struct gb_operation_msg_hdr {
|
|
|
|
__le16 size; /* Size in bytes of header + payload */
|
|
|
|
__le16 id; /* Operation unique id */
|
|
|
|
__u8 type; /* E.g GB_I2C_TYPE_* or GB_GPIO_TYPE_* */
|
|
|
|
/* 3 bytes pad, must be zero (ignore when read) */
|
|
|
|
} __aligned(sizeof(u64));
|
|
|
|
|
|
|
|
/* XXX Could be per-host device, per-module, or even per-connection */
|
|
|
|
static DEFINE_SPINLOCK(gb_operations_lock);
|
|
|
|
|
2014-10-16 11:35:32 +00:00
|
|
|
static void gb_operation_insert(struct gb_operation *operation)
|
|
|
|
{
|
|
|
|
struct gb_connection *connection = operation->connection;
|
|
|
|
struct rb_root *root = &connection->pending;
|
|
|
|
struct rb_node *node = &operation->node;
|
|
|
|
struct rb_node **link = &root->rb_node;
|
|
|
|
struct rb_node *above = NULL;
|
|
|
|
struct gb_operation_msg_hdr *header;
|
|
|
|
__le16 wire_id;
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Assign the operation's id, and store it in the header of
|
|
|
|
* both request and response message headers.
|
|
|
|
*/
|
|
|
|
operation->id = gb_connection_operation_id(connection);
|
|
|
|
wire_id = cpu_to_le16(operation->id);
|
|
|
|
header = operation->request->transfer_buffer;
|
|
|
|
header->id = wire_id;
|
|
|
|
|
|
|
|
/* OK, insert the operation into its connection's tree */
|
|
|
|
spin_lock_irq(&gb_operations_lock);
|
|
|
|
|
|
|
|
while (*link) {
|
|
|
|
struct gb_operation *other;
|
|
|
|
|
|
|
|
above = *link;
|
|
|
|
other = rb_entry(above, struct gb_operation, node);
|
|
|
|
header = other->request->transfer_buffer;
|
|
|
|
if (other->id > operation->id)
|
|
|
|
link = &above->rb_left;
|
|
|
|
else if (other->id < operation->id)
|
|
|
|
link = &above->rb_right;
|
|
|
|
}
|
|
|
|
rb_link_node(node, above, link);
|
|
|
|
rb_insert_color(node, root);
|
|
|
|
|
|
|
|
spin_unlock_irq(&gb_operations_lock);
|
|
|
|
}
|
|
|
|
|
|
|
|
static void gb_operation_remove(struct gb_operation *operation)
|
|
|
|
{
|
|
|
|
spin_lock_irq(&gb_operations_lock);
|
|
|
|
rb_erase(&operation->node, &operation->connection->pending);
|
|
|
|
spin_unlock_irq(&gb_operations_lock);
|
|
|
|
}
|
|
|
|
|
|
|
|
static struct gb_operation *
|
|
|
|
gb_operation_find(struct gb_connection *connection, u16 id)
|
|
|
|
{
|
2014-10-16 11:35:33 +00:00
|
|
|
struct gb_operation *operation = NULL;
|
2014-10-16 11:35:32 +00:00
|
|
|
struct rb_node *node;
|
|
|
|
bool found = false;
|
|
|
|
|
|
|
|
spin_lock_irq(&gb_operations_lock);
|
|
|
|
node = connection->pending.rb_node;
|
|
|
|
while (node && !found) {
|
|
|
|
operation = rb_entry(node, struct gb_operation, node);
|
|
|
|
if (operation->id > id)
|
|
|
|
node = node->rb_left;
|
|
|
|
else if (operation->id < id)
|
|
|
|
node = node->rb_right;
|
|
|
|
else
|
|
|
|
found = true;
|
|
|
|
}
|
|
|
|
spin_unlock_irq(&gb_operations_lock);
|
|
|
|
|
|
|
|
return found ? operation : NULL;
|
|
|
|
}
|
|
|
|
|
2014-10-02 02:54:15 +00:00
|
|
|
/*
|
|
|
|
* An operations's response message has arrived. If no callback was
|
|
|
|
* supplied it was submitted for asynchronous completion, so we notify
|
|
|
|
* any waiters. Otherwise we assume calling the completion is enough
|
|
|
|
* and nobody else will be waiting.
|
|
|
|
*/
|
|
|
|
void gb_operation_complete(struct gb_operation *operation)
|
|
|
|
{
|
2014-10-16 11:35:33 +00:00
|
|
|
/* XXX Should probably report bad status if no callback */
|
2014-10-02 02:54:15 +00:00
|
|
|
if (operation->callback)
|
|
|
|
operation->callback(operation);
|
|
|
|
else
|
|
|
|
complete_all(&operation->completion);
|
2014-10-16 11:35:33 +00:00
|
|
|
gb_operation_destroy(operation);
|
2014-10-02 02:54:15 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Wait for a submitted operatnoi to complete */
|
|
|
|
int gb_operation_wait(struct gb_operation *operation)
|
|
|
|
{
|
|
|
|
int ret;
|
|
|
|
|
|
|
|
ret = wait_for_completion_interruptible(&operation->completion);
|
|
|
|
/* If interrupted, cancel the in-flight buffer */
|
|
|
|
if (ret < 0)
|
2014-10-16 11:35:31 +00:00
|
|
|
ret = greybus_kill_gbuf(operation->request);
|
2014-10-02 02:54:15 +00:00
|
|
|
return ret;
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
2014-10-16 11:35:31 +00:00
|
|
|
* Called when an operation buffer completes.
|
2014-10-02 02:54:15 +00:00
|
|
|
*/
|
2014-10-16 11:35:31 +00:00
|
|
|
static void gb_operation_gbuf_complete(struct gbuf *gbuf)
|
2014-10-02 02:54:15 +00:00
|
|
|
{
|
2014-10-16 11:35:33 +00:00
|
|
|
/* Don't do anything */
|
2014-10-16 11:35:32 +00:00
|
|
|
struct gb_operation *operation;
|
|
|
|
struct gb_operation_msg_hdr *header;
|
|
|
|
u16 id;
|
|
|
|
|
|
|
|
/*
|
|
|
|
* This isn't right, but it keeps things balanced until we
|
|
|
|
* can set up operation response handling.
|
|
|
|
*/
|
|
|
|
header = gbuf->transfer_buffer;
|
|
|
|
id = le16_to_cpu(header->id);
|
|
|
|
operation = gb_operation_find(gbuf->connection, id);
|
|
|
|
if (operation)
|
|
|
|
gb_operation_remove(operation);
|
|
|
|
else
|
|
|
|
gb_connection_err(gbuf->connection, "operation not found");
|
2014-10-02 02:54:15 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
2014-10-16 11:35:31 +00:00
|
|
|
* Allocate a buffer to be used for an operation request or response
|
|
|
|
* message. Both types of message contain a header, which is filled
|
|
|
|
* in here. W
|
|
|
|
*/
|
|
|
|
struct gbuf *gb_operation_gbuf_create(struct gb_operation *operation,
|
|
|
|
u8 type, size_t size, bool outbound)
|
|
|
|
{
|
|
|
|
struct gb_connection *connection = operation->connection;
|
|
|
|
struct gb_operation_msg_hdr *header;
|
|
|
|
struct gbuf *gbuf;
|
|
|
|
gfp_t gfp_flags = outbound ? GFP_KERNEL : GFP_ATOMIC;
|
|
|
|
|
|
|
|
/* Operation buffers hold a header in addition to their payload */
|
|
|
|
size += sizeof(*header);
|
|
|
|
gbuf = greybus_alloc_gbuf(connection, gb_operation_gbuf_complete,
|
|
|
|
size, outbound, gfp_flags, operation);
|
|
|
|
if (!gbuf)
|
|
|
|
return NULL;
|
|
|
|
|
|
|
|
/* Fill in the header structure */
|
|
|
|
header = (struct gb_operation_msg_hdr *)gbuf->transfer_buffer;
|
|
|
|
header->size = cpu_to_le16(size);
|
|
|
|
header->id = 0; /* Filled in when submitted */
|
|
|
|
header->type = type;
|
|
|
|
|
|
|
|
return gbuf;
|
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Create a Greybus operation to be sent over the given connection.
|
|
|
|
* The request buffer will big enough for a payload of the given
|
|
|
|
* size. Outgoing requests must specify the size of the response
|
|
|
|
* buffer size, which must be sufficient to hold all expected
|
|
|
|
* response data.
|
|
|
|
*
|
|
|
|
* Incoming requests will supply a response size of 0, and in that
|
|
|
|
* case no response buffer is allocated. (A response always
|
|
|
|
* includes a status byte, so 0 is not a valid size.) Whatever
|
|
|
|
* handles the operation request is responsible for allocating the
|
|
|
|
* response buffer.
|
2014-10-02 02:54:15 +00:00
|
|
|
*
|
2014-10-16 11:35:31 +00:00
|
|
|
* Returns a pointer to the new operation or a null pointer if an
|
|
|
|
* error occurs.
|
2014-10-02 02:54:15 +00:00
|
|
|
*/
|
|
|
|
struct gb_operation *gb_operation_create(struct gb_connection *connection,
|
2014-10-16 11:35:31 +00:00
|
|
|
u8 type, size_t request_size,
|
|
|
|
size_t response_size)
|
2014-10-02 02:54:15 +00:00
|
|
|
{
|
|
|
|
struct gb_operation *operation;
|
2014-10-16 11:35:31 +00:00
|
|
|
gfp_t gfp_flags = response_size ? GFP_KERNEL : GFP_ATOMIC;
|
|
|
|
|
|
|
|
if (!request_size) {
|
|
|
|
gb_connection_err(connection, "zero-sized request");
|
|
|
|
return NULL;
|
|
|
|
}
|
2014-10-02 02:54:15 +00:00
|
|
|
|
|
|
|
/* XXX Use a slab cache */
|
2014-10-16 11:35:31 +00:00
|
|
|
operation = kzalloc(sizeof(*operation), gfp_flags);
|
2014-10-02 02:54:15 +00:00
|
|
|
if (!operation)
|
|
|
|
return NULL;
|
2014-10-16 11:35:31 +00:00
|
|
|
operation->connection = connection; /* XXX refcount? */
|
2014-10-02 02:54:15 +00:00
|
|
|
|
2014-10-16 11:35:31 +00:00
|
|
|
operation->request = gb_operation_gbuf_create(operation, type,
|
|
|
|
request_size, true);
|
|
|
|
if (!operation->request) {
|
2014-10-02 02:54:15 +00:00
|
|
|
kfree(operation);
|
|
|
|
return NULL;
|
|
|
|
}
|
2014-10-16 11:35:31 +00:00
|
|
|
operation->request_payload = operation->request->transfer_buffer +
|
|
|
|
sizeof(struct gb_operation_msg_hdr);
|
|
|
|
/* We always use the full request buffer */
|
|
|
|
operation->request->actual_length = request_size;
|
|
|
|
|
|
|
|
if (response_size) {
|
|
|
|
type |= GB_OPERATION_TYPE_RESPONSE;
|
|
|
|
operation->response = gb_operation_gbuf_create(operation,
|
|
|
|
type, response_size, false);
|
|
|
|
if (!operation->response) {
|
|
|
|
greybus_free_gbuf(operation->request);
|
|
|
|
kfree(operation);
|
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
operation->response_payload =
|
|
|
|
operation->response->transfer_buffer +
|
|
|
|
sizeof(struct gb_operation_msg_hdr);
|
|
|
|
}
|
2014-10-02 02:54:15 +00:00
|
|
|
|
|
|
|
operation->callback = NULL; /* set at submit time */
|
|
|
|
init_completion(&operation->completion);
|
|
|
|
|
|
|
|
spin_lock_irq(&gb_operations_lock);
|
|
|
|
list_add_tail(&operation->links, &connection->operations);
|
|
|
|
spin_unlock_irq(&gb_operations_lock);
|
|
|
|
|
|
|
|
return operation;
|
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Destroy a previously created operation.
|
|
|
|
*/
|
|
|
|
void gb_operation_destroy(struct gb_operation *operation)
|
|
|
|
{
|
|
|
|
if (WARN_ON(!operation))
|
|
|
|
return;
|
|
|
|
|
|
|
|
/* XXX Make sure it's not in flight */
|
|
|
|
spin_lock_irq(&gb_operations_lock);
|
|
|
|
list_del(&operation->links);
|
|
|
|
spin_unlock_irq(&gb_operations_lock);
|
|
|
|
|
2014-10-16 11:35:31 +00:00
|
|
|
greybus_free_gbuf(operation->response);
|
|
|
|
greybus_free_gbuf(operation->request);
|
2014-10-02 02:54:15 +00:00
|
|
|
|
|
|
|
kfree(operation);
|
|
|
|
}
|
2014-10-16 11:35:33 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* Send an operation request message. The caller has filled in
|
|
|
|
* any payload so the request message is ready to go. If non-null,
|
|
|
|
* the callback function supplied will be called when the response
|
|
|
|
* message has arrived indicating the operation is complete. A null
|
|
|
|
* callback function is used for a synchronous request; return from
|
|
|
|
* this function won't occur until the operation is complete (or an
|
|
|
|
* interrupt occurs).
|
|
|
|
*/
|
|
|
|
int gb_operation_request_send(struct gb_operation *operation,
|
|
|
|
gb_operation_callback callback)
|
|
|
|
{
|
|
|
|
int ret;
|
|
|
|
|
|
|
|
/*
|
|
|
|
* XXX
|
|
|
|
* I think the order of operations is going to be
|
|
|
|
* significant, and if so, we may need a mutex to surround
|
|
|
|
* setting the operation id and submitting the gbuf.
|
|
|
|
*/
|
|
|
|
operation->callback = callback;
|
|
|
|
gb_operation_insert(operation);
|
|
|
|
ret = greybus_submit_gbuf(operation->request, GFP_KERNEL);
|
|
|
|
if (ret)
|
|
|
|
return ret;
|
|
|
|
if (!callback)
|
|
|
|
ret = gb_operation_wait(operation);
|
|
|
|
|
|
|
|
return ret;
|
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Send a response for an incoming operation request.
|
|
|
|
*/
|
|
|
|
int gb_operation_response_send(struct gb_operation *operation)
|
|
|
|
{
|
|
|
|
/* XXX
|
|
|
|
* Caller needs to have set operation->response->actual_length
|
|
|
|
*/
|
|
|
|
gb_operation_remove(operation);
|
|
|
|
gb_operation_destroy(operation);
|
|
|
|
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
void gb_connection_operation_recv(struct gb_connection *connection,
|
|
|
|
void *data, size_t size)
|
|
|
|
{
|
|
|
|
struct gb_operation_msg_hdr *header;
|
|
|
|
struct gb_operation *operation;
|
|
|
|
struct gbuf *gbuf;
|
|
|
|
u16 msg_size;
|
|
|
|
|
|
|
|
if (size > GB_OPERATION_MESSAGE_SIZE_MAX) {
|
|
|
|
gb_connection_err(connection, "message too big");
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
header = data;
|
|
|
|
msg_size = le16_to_cpu(header->size);
|
|
|
|
if (header->type & GB_OPERATION_TYPE_RESPONSE) {
|
|
|
|
u16 id = le16_to_cpu(header->id);
|
|
|
|
|
|
|
|
operation = gb_operation_find(connection, id);
|
|
|
|
if (!operation) {
|
|
|
|
gb_connection_err(connection, "operation not found");
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
gb_operation_remove(operation);
|
|
|
|
gbuf = operation->response;
|
|
|
|
if (size > gbuf->transfer_buffer_length) {
|
|
|
|
gb_connection_err(connection, "recv buffer too small");
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
WARN_ON(msg_size != size);
|
|
|
|
operation = gb_operation_create(connection, header->type,
|
|
|
|
msg_size, 0);
|
|
|
|
if (!operation) {
|
|
|
|
gb_connection_err(connection, "can't create operation");
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
gbuf = operation->request;
|
|
|
|
}
|
|
|
|
|
|
|
|
memcpy(gbuf->transfer_buffer, data, msg_size);
|
|
|
|
gbuf->actual_length = msg_size;
|
|
|
|
|
|
|
|
/* XXX And now we let a work queue handle the rest */
|
|
|
|
}
|