2014-10-01 20:54:15 -06: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 05:35:31 -06: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-27 01:40:09 -06:00
|
|
|
#define OPERATION_TIMEOUT_DEFAULT 1000 /* milliseconds */
|
2014-10-22 01:04:28 -06:00
|
|
|
|
2014-10-16 05:35:33 -06:00
|
|
|
/*
|
|
|
|
* XXX This needs to be coordinated with host driver parameters
|
2014-11-17 17:08:32 -07:00
|
|
|
* XXX May need to reduce to allow for message header within a page
|
2014-10-16 05:35:33 -06:00
|
|
|
*/
|
|
|
|
#define GB_OPERATION_MESSAGE_SIZE_MAX 4096
|
|
|
|
|
2014-10-20 09:27:56 -06:00
|
|
|
static struct kmem_cache *gb_operation_cache;
|
2014-12-02 07:30:35 -07:00
|
|
|
static struct kmem_cache *gb_simple_message_cache;
|
2014-10-20 09:27:56 -06:00
|
|
|
|
2014-10-16 05:35:34 -06:00
|
|
|
/* Workqueue to handle Greybus operation completions. */
|
2014-11-21 18:29:13 -07:00
|
|
|
static struct workqueue_struct *gb_operation_workqueue;
|
2014-10-16 05:35:34 -06:00
|
|
|
|
2014-11-25 15:54:04 -07:00
|
|
|
/* Protects the cookie representing whether a message is in flight */
|
|
|
|
static DEFINE_MUTEX(gb_message_mutex);
|
|
|
|
|
2014-10-01 20:54:15 -06:00
|
|
|
/*
|
|
|
|
* All operation messages (both requests and responses) begin with
|
2014-11-19 16:55:03 -07:00
|
|
|
* a 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. The header contains an
|
|
|
|
* operation type field, whose interpretation is dependent on what
|
|
|
|
* type of protocol is used over the connection.
|
|
|
|
*
|
|
|
|
* The high bit (0x80) of the operation type field is used to
|
|
|
|
* indicate whether the message is a request (clear) or a response
|
|
|
|
* (set).
|
|
|
|
*
|
|
|
|
* Response messages include an additional status byte, which
|
|
|
|
* communicates the result of the corresponding request. A zero
|
|
|
|
* status value means the operation completed successfully. Any
|
|
|
|
* other value indicates an error; in this case, the payload of the
|
|
|
|
* response message (if any) is ignored. The status byte must be
|
|
|
|
* zero in the header for a request message.
|
2014-10-01 20:54:15 -06:00
|
|
|
*
|
|
|
|
* 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 {
|
2014-11-19 11:27:16 -07:00
|
|
|
__le16 size; /* Size in bytes of header + payload */
|
|
|
|
__le16 operation_id; /* Operation unique id */
|
|
|
|
__u8 type; /* E.g GB_I2C_TYPE_* or GB_GPIO_TYPE_* */
|
2014-11-19 16:55:03 -07:00
|
|
|
__u8 result; /* Result of request (in responses only) */
|
|
|
|
/* 2 bytes pad, must be zero (ignore when read) */
|
2014-10-01 20:54:15 -06:00
|
|
|
} __aligned(sizeof(u64));
|
|
|
|
|
|
|
|
/* XXX Could be per-host device, per-module, or even per-connection */
|
|
|
|
static DEFINE_SPINLOCK(gb_operations_lock);
|
|
|
|
|
2014-11-25 10:33:15 -07:00
|
|
|
/*
|
2014-12-01 06:53:08 -07:00
|
|
|
* Set an operation's result.
|
|
|
|
*
|
|
|
|
* Initially an outgoing operation's errno value is -EBADR.
|
|
|
|
* If no error occurs before sending the request message the only
|
|
|
|
* valid value operation->errno can be set to is -EINPROGRESS,
|
|
|
|
* indicating the request has been (or rather is about to be) sent.
|
|
|
|
* At that point nobody should be looking at the result until the
|
|
|
|
* reponse arrives.
|
2014-11-25 10:33:15 -07:00
|
|
|
*
|
|
|
|
* The first time the result gets set after the request has been
|
|
|
|
* sent, that result "sticks." That is, if two concurrent threads
|
|
|
|
* race to set the result, the first one wins. The return value
|
|
|
|
* tells the caller whether its result was recorded; if not the
|
2014-12-01 06:53:08 -07:00
|
|
|
* caller has nothing more to do.
|
|
|
|
*
|
|
|
|
* The result value -EILSEQ is reserved to signal an implementation
|
|
|
|
* error; if it's ever observed, the code performing the request has
|
|
|
|
* done something fundamentally wrong. It is an error to try to set
|
|
|
|
* the result to -EBADR, and attempts to do so result in a warning,
|
|
|
|
* and -EILSEQ is used instead. Similarly, the only valid result
|
|
|
|
* value to set for an operation in initial state is -EINPROGRESS.
|
|
|
|
* Attempts to do otherwise will also record a (successful) -EILSEQ
|
|
|
|
* operation result.
|
2014-11-25 10:33:15 -07:00
|
|
|
*/
|
2014-11-25 10:33:14 -07:00
|
|
|
static bool gb_operation_result_set(struct gb_operation *operation, int result)
|
2014-11-25 10:33:13 -07:00
|
|
|
{
|
2014-11-25 15:54:02 -07:00
|
|
|
int prev;
|
|
|
|
|
2014-11-25 10:33:15 -07:00
|
|
|
if (result == -EINPROGRESS) {
|
2014-12-01 06:53:08 -07:00
|
|
|
/*
|
|
|
|
* -EINPROGRESS is used to indicate the request is
|
|
|
|
* in flight. It should be the first result value
|
|
|
|
* set after the initial -EBADR. Issue a warning
|
|
|
|
* and record an implementation error if it's
|
|
|
|
* set at any other time.
|
|
|
|
*/
|
2014-11-25 15:54:02 -07:00
|
|
|
spin_lock_irq(&gb_operations_lock);
|
|
|
|
prev = operation->errno;
|
|
|
|
if (prev == -EBADR)
|
|
|
|
operation->errno = result;
|
2014-12-01 06:53:08 -07:00
|
|
|
else
|
|
|
|
operation->errno = -EILSEQ;
|
2014-11-25 15:54:02 -07:00
|
|
|
spin_unlock_irq(&gb_operations_lock);
|
2014-12-01 06:53:08 -07:00
|
|
|
WARN_ON(prev != -EBADR);
|
2014-11-25 15:54:02 -07:00
|
|
|
|
2014-12-01 06:53:08 -07:00
|
|
|
return true;
|
2014-11-25 10:33:15 -07:00
|
|
|
}
|
|
|
|
|
2014-12-01 06:53:08 -07:00
|
|
|
/*
|
|
|
|
* The first result value set after a request has been sent
|
|
|
|
* will be the final result of the operation. Subsequent
|
|
|
|
* attempts to set the result are ignored.
|
|
|
|
*
|
|
|
|
* Note that -EBADR is a reserved "initial state" result
|
|
|
|
* value. Attempts to set this value result in a warning,
|
|
|
|
* and the result code is set to -EILSEQ instead.
|
|
|
|
*/
|
|
|
|
if (WARN_ON(result == -EBADR))
|
|
|
|
result = -EILSEQ; /* Nobody should be setting -EBADR */
|
|
|
|
|
2014-11-25 15:54:02 -07:00
|
|
|
spin_lock_irq(&gb_operations_lock);
|
|
|
|
prev = operation->errno;
|
|
|
|
if (prev == -EINPROGRESS)
|
2014-12-01 06:53:08 -07:00
|
|
|
operation->errno = result; /* First and final result */
|
2014-11-25 15:54:02 -07:00
|
|
|
spin_unlock_irq(&gb_operations_lock);
|
|
|
|
|
|
|
|
return prev == -EINPROGRESS;
|
2014-11-25 10:33:13 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
int gb_operation_result(struct gb_operation *operation)
|
|
|
|
{
|
2014-11-25 10:33:15 -07:00
|
|
|
int result = operation->errno;
|
|
|
|
|
2014-12-01 06:53:08 -07:00
|
|
|
WARN_ON(result == -EBADR);
|
2014-11-25 10:33:15 -07:00
|
|
|
WARN_ON(result == -EINPROGRESS);
|
|
|
|
|
|
|
|
return result;
|
2014-11-25 10:33:13 -07:00
|
|
|
}
|
|
|
|
|
2014-11-12 14:17:53 -07:00
|
|
|
static void gb_pending_operation_insert(struct gb_operation *operation)
|
2014-10-16 05:35:32 -06:00
|
|
|
{
|
|
|
|
struct gb_connection *connection = operation->connection;
|
|
|
|
struct gb_operation_msg_hdr *header;
|
|
|
|
|
2014-11-12 14:17:54 -07:00
|
|
|
/*
|
|
|
|
* Assign the operation's id and move it into its
|
|
|
|
* connection's pending list.
|
2014-10-16 05:35:32 -06:00
|
|
|
*/
|
|
|
|
spin_lock_irq(&gb_operations_lock);
|
2014-11-12 14:17:54 -07:00
|
|
|
operation->id = ++connection->op_cycle;
|
2014-11-12 14:17:53 -07:00
|
|
|
list_move_tail(&operation->links, &connection->pending);
|
2014-10-16 05:35:32 -06:00
|
|
|
spin_unlock_irq(&gb_operations_lock);
|
2014-11-12 14:17:54 -07:00
|
|
|
|
|
|
|
/* Store the operation id in the request header */
|
2014-11-20 15:09:15 -07:00
|
|
|
header = operation->request->header;
|
2014-11-19 11:27:16 -07:00
|
|
|
header->operation_id = cpu_to_le16(operation->id);
|
2014-10-16 05:35:32 -06:00
|
|
|
}
|
|
|
|
|
2014-11-12 14:17:53 -07:00
|
|
|
static void gb_pending_operation_remove(struct gb_operation *operation)
|
2014-10-16 05:35:32 -06:00
|
|
|
{
|
2014-10-22 01:04:28 -06:00
|
|
|
struct gb_connection *connection = operation->connection;
|
|
|
|
|
2014-10-27 01:40:09 -06:00
|
|
|
/* Take us off of the list of pending operations */
|
2014-10-16 05:35:32 -06:00
|
|
|
spin_lock_irq(&gb_operations_lock);
|
2014-11-12 14:17:53 -07:00
|
|
|
list_move_tail(&operation->links, &connection->operations);
|
2014-10-16 05:35:32 -06:00
|
|
|
spin_unlock_irq(&gb_operations_lock);
|
|
|
|
}
|
|
|
|
|
|
|
|
static struct gb_operation *
|
2014-11-19 11:27:16 -07:00
|
|
|
gb_pending_operation_find(struct gb_connection *connection, u16 operation_id)
|
2014-10-16 05:35:32 -06:00
|
|
|
{
|
2014-11-12 14:17:53 -07:00
|
|
|
struct gb_operation *operation;
|
2014-10-16 05:35:32 -06:00
|
|
|
bool found = false;
|
|
|
|
|
|
|
|
spin_lock_irq(&gb_operations_lock);
|
2014-11-12 14:17:53 -07:00
|
|
|
list_for_each_entry(operation, &connection->pending, links)
|
2014-11-19 11:27:16 -07:00
|
|
|
if (operation->id == operation_id) {
|
2014-10-16 05:35:32 -06:00
|
|
|
found = true;
|
2014-11-12 14:17:53 -07:00
|
|
|
break;
|
|
|
|
}
|
2014-10-16 05:35:32 -06:00
|
|
|
spin_unlock_irq(&gb_operations_lock);
|
|
|
|
|
|
|
|
return found ? operation : NULL;
|
|
|
|
}
|
|
|
|
|
2014-12-01 06:53:10 -07:00
|
|
|
static int gb_message_send(struct gb_message *message)
|
2014-11-17 17:08:37 -07:00
|
|
|
{
|
2014-11-18 12:26:52 -07:00
|
|
|
struct gb_connection *connection = message->operation->connection;
|
2014-11-18 12:26:53 -07:00
|
|
|
u16 dest_cport_id = connection->interface_cport_id;
|
2014-11-19 11:27:15 -07:00
|
|
|
int ret = 0;
|
2014-11-25 15:54:04 -07:00
|
|
|
void *cookie;
|
2014-11-18 12:26:48 -07:00
|
|
|
|
2014-11-25 15:54:04 -07:00
|
|
|
mutex_lock(&gb_message_mutex);
|
|
|
|
cookie = connection->hd->driver->buffer_send(connection->hd,
|
2014-11-18 12:26:53 -07:00
|
|
|
dest_cport_id,
|
2014-11-20 15:09:14 -07:00
|
|
|
message->header,
|
|
|
|
message->size,
|
2014-12-01 06:53:10 -07:00
|
|
|
GFP_KERNEL);
|
2014-11-25 15:54:04 -07:00
|
|
|
if (IS_ERR(cookie))
|
|
|
|
ret = PTR_ERR(cookie);
|
|
|
|
else
|
|
|
|
message->cookie = cookie;
|
|
|
|
mutex_unlock(&gb_message_mutex);
|
|
|
|
|
2014-11-19 11:27:15 -07:00
|
|
|
return ret;
|
2014-11-17 17:08:37 -07:00
|
|
|
}
|
|
|
|
|
2014-11-19 11:27:15 -07:00
|
|
|
/*
|
|
|
|
* Cancel a message whose buffer we have passed to the host device
|
|
|
|
* layer to be sent.
|
|
|
|
*/
|
2014-11-18 12:26:49 -07:00
|
|
|
static void gb_message_cancel(struct gb_message *message)
|
2014-11-17 17:08:37 -07:00
|
|
|
{
|
2014-11-25 15:54:04 -07:00
|
|
|
mutex_lock(&gb_message_mutex);
|
|
|
|
if (message->cookie) {
|
|
|
|
struct greybus_host_device *hd;
|
2014-11-17 17:08:37 -07:00
|
|
|
|
2014-11-25 15:54:04 -07:00
|
|
|
hd = message->operation->connection->hd;
|
|
|
|
hd->driver->buffer_cancel(message->cookie);
|
|
|
|
}
|
|
|
|
mutex_unlock(&gb_message_mutex);
|
2014-11-17 17:08:37 -07:00
|
|
|
}
|
2014-11-18 12:26:44 -07:00
|
|
|
|
2014-10-16 05:35:34 -06:00
|
|
|
static void gb_operation_request_handle(struct gb_operation *operation)
|
|
|
|
{
|
2014-11-05 15:12:55 -07:00
|
|
|
struct gb_protocol *protocol = operation->connection->protocol;
|
|
|
|
struct gb_operation_msg_hdr *header;
|
2014-10-16 05:35:34 -06:00
|
|
|
|
2014-11-20 15:09:15 -07:00
|
|
|
header = operation->request->header;
|
2014-11-12 14:17:55 -07:00
|
|
|
|
2014-11-05 15:12:55 -07:00
|
|
|
/*
|
|
|
|
* If the protocol has no incoming request handler, report
|
|
|
|
* an error and mark the request bad.
|
|
|
|
*/
|
|
|
|
if (protocol->request_recv) {
|
2014-11-12 14:17:55 -07:00
|
|
|
protocol->request_recv(header->type, operation);
|
2014-11-19 04:55:00 -07:00
|
|
|
return;
|
2014-10-16 05:35:34 -06:00
|
|
|
}
|
|
|
|
|
2014-10-28 18:35:59 -06:00
|
|
|
gb_connection_err(operation->connection,
|
2014-11-05 15:12:55 -07:00
|
|
|
"unexpected incoming request type 0x%02hhx\n", header->type);
|
2014-12-02 07:30:37 -07:00
|
|
|
if (gb_operation_result_set(operation, -EPROTONOSUPPORT))
|
|
|
|
queue_work(gb_operation_workqueue, &operation->work);
|
|
|
|
else
|
|
|
|
WARN(true, "failed to mark request bad\n");
|
2014-10-16 05:35:34 -06:00
|
|
|
}
|
|
|
|
|
2014-10-01 20:54:15 -06:00
|
|
|
/*
|
2014-12-02 07:30:37 -07:00
|
|
|
* Complete an operation in non-atomic context. For incoming
|
|
|
|
* requests, the callback function is the request handler, and
|
|
|
|
* the operation result should be -EINPROGRESS at this point.
|
|
|
|
*
|
|
|
|
* For outgoing requests, the operation result value should have
|
|
|
|
* been set before queueing this. The operation callback function
|
|
|
|
* allows the original requester to know the request has completed
|
|
|
|
* and its result is available.
|
2014-10-01 20:54:15 -06:00
|
|
|
*/
|
2014-11-21 18:29:13 -07:00
|
|
|
static void gb_operation_work(struct work_struct *work)
|
2014-10-01 20:54:15 -06:00
|
|
|
{
|
2014-10-16 05:35:32 -06:00
|
|
|
struct gb_operation *operation;
|
|
|
|
|
2014-11-21 18:29:13 -07:00
|
|
|
operation = container_of(work, struct gb_operation, work);
|
2014-12-01 06:53:11 -07:00
|
|
|
if (operation->callback) {
|
|
|
|
operation->callback(operation);
|
|
|
|
operation->callback = NULL;
|
|
|
|
}
|
2014-11-21 18:29:20 -07:00
|
|
|
gb_operation_put(operation);
|
2014-10-16 05:35:34 -06:00
|
|
|
}
|
|
|
|
|
2014-10-27 01:40:09 -06:00
|
|
|
/*
|
|
|
|
* Timeout call for the operation.
|
|
|
|
*/
|
2014-11-21 18:29:17 -07:00
|
|
|
static void gb_operation_timeout(struct work_struct *work)
|
2014-10-27 01:40:09 -06:00
|
|
|
{
|
|
|
|
struct gb_operation *operation;
|
|
|
|
|
|
|
|
operation = container_of(work, struct gb_operation, timeout_work.work);
|
2014-11-21 18:29:17 -07:00
|
|
|
gb_operation_cancel(operation, -ETIMEDOUT);
|
2014-10-27 01:40:09 -06:00
|
|
|
}
|
|
|
|
|
2014-11-20 15:09:17 -07:00
|
|
|
/*
|
|
|
|
* Given a pointer to the header in a message sent on a given host
|
|
|
|
* device, return the associated message structure. (This "header"
|
|
|
|
* is just the buffer pointer we supply to the host device for
|
|
|
|
* sending.)
|
|
|
|
*/
|
|
|
|
static struct gb_message *
|
|
|
|
gb_hd_message_find(struct greybus_host_device *hd, void *header)
|
|
|
|
{
|
|
|
|
struct gb_message *message;
|
|
|
|
u8 *result;
|
|
|
|
|
|
|
|
result = (u8 *)header - hd->buffer_headroom - sizeof(*message);
|
|
|
|
message = (struct gb_message *)result;
|
|
|
|
|
|
|
|
return message;
|
|
|
|
}
|
|
|
|
|
2014-12-02 07:30:33 -07:00
|
|
|
static void gb_operation_message_init(struct greybus_host_device *hd,
|
|
|
|
struct gb_message *message, u16 operation_id,
|
|
|
|
size_t message_size, u8 type)
|
|
|
|
{
|
|
|
|
struct gb_operation_msg_hdr *header;
|
|
|
|
u8 *buffer;
|
|
|
|
|
|
|
|
BUG_ON(message_size < sizeof(*header));
|
|
|
|
buffer = &message->buffer[0];
|
|
|
|
header = (struct gb_operation_msg_hdr *)(buffer + hd->buffer_headroom);
|
|
|
|
|
|
|
|
message->header = header;
|
|
|
|
message->payload = header + 1;
|
|
|
|
message->size = message_size;
|
|
|
|
|
|
|
|
/*
|
|
|
|
* The type supplied for incoming message buffers will be
|
|
|
|
* 0x00. Such buffers will be overwritten by arriving data
|
|
|
|
* so there's no need to initialize the message header.
|
|
|
|
*/
|
|
|
|
if (type) {
|
|
|
|
/*
|
|
|
|
* For a request, the operation id gets filled in
|
|
|
|
* when the message is sent. For a response, it
|
|
|
|
* will be copied from the request by the caller.
|
|
|
|
*
|
|
|
|
* The result field in a request message must be
|
|
|
|
* zero. It will be set just prior to sending for
|
|
|
|
* a response.
|
|
|
|
*/
|
|
|
|
header->size = cpu_to_le16(message_size);
|
|
|
|
header->operation_id = 0;
|
|
|
|
header->type = type;
|
|
|
|
header->result = 0;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2014-10-01 20:54:15 -06:00
|
|
|
/*
|
2014-12-02 07:30:32 -07:00
|
|
|
* Allocate a message to be used for an operation request or response.
|
|
|
|
* Both types of message contain a common header. The request message
|
|
|
|
* for an outgoing operation is outbound, as is the response message
|
|
|
|
* for an incoming operation. The message header for an outbound
|
|
|
|
* message is partially initialized here.
|
|
|
|
*
|
|
|
|
* The headers for inbound messages don't need to be initialized;
|
|
|
|
* they'll be filled in by arriving data.
|
2014-11-20 15:09:16 -07:00
|
|
|
*
|
|
|
|
* Our message structure consists of:
|
|
|
|
* message structure
|
|
|
|
* headroom
|
|
|
|
* message header \_ these combined are
|
|
|
|
* message payload / the message size
|
2014-10-16 05:35:31 -06:00
|
|
|
*/
|
2014-11-20 15:09:15 -07:00
|
|
|
static struct gb_message *
|
|
|
|
gb_operation_message_alloc(struct greybus_host_device *hd, u8 type,
|
2014-11-20 15:09:16 -07:00
|
|
|
size_t payload_size, gfp_t gfp_flags)
|
2014-10-16 05:35:31 -06:00
|
|
|
{
|
2014-11-17 17:08:32 -07:00
|
|
|
struct gb_message *message;
|
2014-10-16 05:35:31 -06:00
|
|
|
struct gb_operation_msg_hdr *header;
|
2014-11-20 15:09:16 -07:00
|
|
|
size_t message_size = payload_size + sizeof(*header);
|
|
|
|
size_t size;
|
2014-10-16 05:35:31 -06:00
|
|
|
|
2014-12-01 06:53:07 -07:00
|
|
|
if (hd->buffer_size_max > GB_OPERATION_MESSAGE_SIZE_MAX) {
|
|
|
|
pr_warn("limiting buffer size to %u\n",
|
|
|
|
GB_OPERATION_MESSAGE_SIZE_MAX);
|
|
|
|
hd->buffer_size_max = GB_OPERATION_MESSAGE_SIZE_MAX;
|
|
|
|
}
|
|
|
|
|
2014-12-02 07:30:35 -07:00
|
|
|
/* Allocate the message. Use the slab cache for simple messages */
|
|
|
|
if (payload_size) {
|
|
|
|
if (message_size > hd->buffer_size_max) {
|
|
|
|
pr_warn("requested message size too big (%zu > %zu)\n",
|
|
|
|
message_size, hd->buffer_size_max);
|
|
|
|
return NULL;
|
|
|
|
}
|
2014-11-17 07:08:39 -07:00
|
|
|
|
2014-12-02 07:30:35 -07:00
|
|
|
size = sizeof(*message) + hd->buffer_headroom + message_size;
|
|
|
|
message = kzalloc(size, gfp_flags);
|
|
|
|
} else {
|
|
|
|
message = kmem_cache_zalloc(gb_simple_message_cache, gfp_flags);
|
|
|
|
}
|
2014-11-20 15:09:15 -07:00
|
|
|
if (!message)
|
|
|
|
return NULL;
|
2014-10-16 05:35:31 -06:00
|
|
|
|
2014-12-02 07:30:33 -07:00
|
|
|
/* Initialize the message. Operation id is filled in later. */
|
|
|
|
gb_operation_message_init(hd, message, 0, message_size, type);
|
2014-12-02 07:30:32 -07:00
|
|
|
|
2014-11-20 15:09:15 -07:00
|
|
|
return message;
|
2014-11-17 17:08:32 -07:00
|
|
|
}
|
|
|
|
|
2014-11-20 15:09:15 -07:00
|
|
|
static void gb_operation_message_free(struct gb_message *message)
|
2014-11-17 17:08:32 -07:00
|
|
|
{
|
2014-12-02 07:30:35 -07:00
|
|
|
if (message->size > sizeof(message->header))
|
|
|
|
kfree(message);
|
|
|
|
else
|
|
|
|
kmem_cache_free(gb_simple_message_cache, message);
|
2014-10-16 05:35:31 -06:00
|
|
|
}
|
|
|
|
|
2014-11-19 16:55:04 -07:00
|
|
|
/*
|
2014-11-20 22:56:30 -07:00
|
|
|
* Map an enum gb_operation_status value (which is represented in a
|
|
|
|
* message as a single byte) to an appropriate Linux negative errno.
|
2014-11-19 16:55:04 -07:00
|
|
|
*/
|
|
|
|
int gb_operation_status_map(u8 status)
|
|
|
|
{
|
|
|
|
switch (status) {
|
|
|
|
case GB_OP_SUCCESS:
|
|
|
|
return 0;
|
|
|
|
case GB_OP_INTERRUPTED:
|
|
|
|
return -EINTR;
|
2014-12-01 06:53:09 -07:00
|
|
|
case GB_OP_TIMEOUT:
|
|
|
|
return -ETIMEDOUT;
|
|
|
|
case GB_OP_NO_MEMORY:
|
|
|
|
return -ENOMEM;
|
2014-11-19 16:55:04 -07:00
|
|
|
case GB_OP_PROTOCOL_BAD:
|
|
|
|
return -EPROTONOSUPPORT;
|
|
|
|
case GB_OP_OVERFLOW:
|
2014-11-25 12:06:44 -07:00
|
|
|
return -EMSGSIZE;
|
2014-12-01 06:53:09 -07:00
|
|
|
case GB_OP_INVALID:
|
|
|
|
return -EINVAL;
|
|
|
|
case GB_OP_RETRY:
|
|
|
|
return -EAGAIN;
|
|
|
|
case GB_OP_MALFUNCTION:
|
|
|
|
return -EILSEQ;
|
|
|
|
case GB_OP_UNKNOWN_ERROR:
|
2014-11-19 16:55:04 -07:00
|
|
|
default:
|
|
|
|
return -EIO;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2014-10-16 05:35:31 -06:00
|
|
|
/*
|
|
|
|
* Create a Greybus operation to be sent over the given connection.
|
2014-11-20 22:56:30 -07:00
|
|
|
* The request buffer will be big enough for a payload of the given
|
2014-12-02 07:30:32 -07:00
|
|
|
* size.
|
|
|
|
*
|
|
|
|
* For outgoing requests, the request message's header will be
|
|
|
|
* initialized with the type of the request and the message size.
|
|
|
|
* Outgoing operations must also specify the response buffer size,
|
|
|
|
* which must be sufficient to hold all expected response data. The
|
|
|
|
* response message header will eventually be overwritten, so there's
|
|
|
|
* no need to initialize it here.
|
2014-10-16 05:35:31 -06:00
|
|
|
*
|
2014-12-02 07:30:32 -07:00
|
|
|
* Request messages for incoming operations can arrive in interrupt
|
|
|
|
* context, so they must be allocated with GFP_ATOMIC. In this case
|
|
|
|
* the request buffer will be immediately overwritten, so there is
|
|
|
|
* no need to initialize the message header. Responsibility for
|
|
|
|
* allocating a response buffer lies with the incoming request
|
|
|
|
* handler for a protocol. So we don't allocate that here.
|
2014-10-01 20:54:15 -06:00
|
|
|
*
|
2014-10-16 05:35:31 -06:00
|
|
|
* Returns a pointer to the new operation or a null pointer if an
|
|
|
|
* error occurs.
|
2014-10-01 20:54:15 -06:00
|
|
|
*/
|
2014-11-19 16:55:02 -07:00
|
|
|
static struct gb_operation *
|
2014-12-02 07:30:32 -07:00
|
|
|
gb_operation_create_common(struct gb_connection *connection, u8 type,
|
|
|
|
size_t request_size, size_t response_size)
|
2014-10-01 20:54:15 -06:00
|
|
|
{
|
2014-11-20 15:09:15 -07:00
|
|
|
struct greybus_host_device *hd = connection->hd;
|
2014-10-01 20:54:15 -06:00
|
|
|
struct gb_operation *operation;
|
2014-12-02 07:30:32 -07:00
|
|
|
gfp_t gfp_flags = type ? GFP_KERNEL : GFP_ATOMIC;
|
2014-10-01 20:54:15 -06:00
|
|
|
|
2014-10-20 09:27:56 -06:00
|
|
|
operation = kmem_cache_zalloc(gb_operation_cache, gfp_flags);
|
2014-10-01 20:54:15 -06:00
|
|
|
if (!operation)
|
|
|
|
return NULL;
|
2014-10-27 03:58:54 -06:00
|
|
|
operation->connection = connection;
|
2014-10-01 20:54:15 -06:00
|
|
|
|
2014-11-20 15:09:15 -07:00
|
|
|
operation->request = gb_operation_message_alloc(hd, type, request_size,
|
|
|
|
gfp_flags);
|
|
|
|
if (!operation->request)
|
2014-10-20 09:27:56 -06:00
|
|
|
goto err_cache;
|
2014-11-20 15:09:15 -07:00
|
|
|
operation->request->operation = operation;
|
2014-10-16 05:35:31 -06:00
|
|
|
|
2014-12-02 07:30:32 -07:00
|
|
|
/* Allocate the response buffer for outgoing operations */
|
|
|
|
if (type) {
|
2014-11-20 15:09:15 -07:00
|
|
|
type |= GB_OPERATION_TYPE_RESPONSE;
|
|
|
|
operation->response = gb_operation_message_alloc(hd, type,
|
|
|
|
response_size, GFP_KERNEL);
|
|
|
|
if (!operation->response)
|
2014-10-20 09:27:56 -06:00
|
|
|
goto err_request;
|
2014-11-20 15:09:15 -07:00
|
|
|
operation->response->operation = operation;
|
2014-10-16 05:35:31 -06:00
|
|
|
}
|
2014-11-25 10:33:15 -07:00
|
|
|
operation->errno = -EBADR; /* Initial value--means "never set" */
|
2014-10-01 20:54:15 -06:00
|
|
|
|
2014-11-21 18:29:13 -07:00
|
|
|
INIT_WORK(&operation->work, gb_operation_work);
|
2014-10-01 20:54:15 -06:00
|
|
|
operation->callback = NULL; /* set at submit time */
|
|
|
|
init_completion(&operation->completion);
|
2014-11-21 18:29:17 -07:00
|
|
|
INIT_DELAYED_WORK(&operation->timeout_work, gb_operation_timeout);
|
2014-11-17 07:08:40 -07:00
|
|
|
kref_init(&operation->kref);
|
2014-10-01 20:54:15 -06:00
|
|
|
|
|
|
|
spin_lock_irq(&gb_operations_lock);
|
|
|
|
list_add_tail(&operation->links, &connection->operations);
|
|
|
|
spin_unlock_irq(&gb_operations_lock);
|
|
|
|
|
|
|
|
return operation;
|
2014-10-20 09:27:56 -06:00
|
|
|
|
|
|
|
err_request:
|
2014-11-20 15:09:15 -07:00
|
|
|
gb_operation_message_free(operation->request);
|
2014-10-20 09:27:56 -06:00
|
|
|
err_cache:
|
|
|
|
kmem_cache_free(gb_operation_cache, operation);
|
|
|
|
|
|
|
|
return NULL;
|
2014-10-01 20:54:15 -06:00
|
|
|
}
|
|
|
|
|
2014-12-02 07:30:31 -07:00
|
|
|
/*
|
|
|
|
* Create a new operation associated with the given connection. The
|
|
|
|
* request and response sizes provided are the number of bytes
|
|
|
|
* required to hold the request/response payload only. Both of
|
|
|
|
* these are allowed to be 0. Note that 0x00 is reserved as an
|
|
|
|
* invalid operation type for all protocols, and this is enforced
|
|
|
|
* here.
|
|
|
|
*/
|
2014-11-19 16:55:02 -07:00
|
|
|
struct gb_operation *gb_operation_create(struct gb_connection *connection,
|
|
|
|
u8 type, size_t request_size,
|
|
|
|
size_t response_size)
|
|
|
|
{
|
2014-12-02 07:30:31 -07:00
|
|
|
if (WARN_ON_ONCE(!type))
|
|
|
|
return NULL;
|
|
|
|
if (WARN_ON_ONCE(type & GB_OPERATION_TYPE_RESPONSE))
|
|
|
|
type &= ~GB_OPERATION_TYPE_RESPONSE;
|
|
|
|
|
2014-12-02 07:30:32 -07:00
|
|
|
return gb_operation_create_common(connection, type,
|
2014-11-19 16:55:02 -07:00
|
|
|
request_size, response_size);
|
|
|
|
}
|
|
|
|
|
|
|
|
static struct gb_operation *
|
2014-12-02 07:30:32 -07:00
|
|
|
gb_operation_create_incoming(struct gb_connection *connection, u16 id,
|
2014-12-02 07:30:28 -07:00
|
|
|
void *data, size_t request_size)
|
2014-11-19 16:55:02 -07:00
|
|
|
{
|
2014-12-02 07:30:28 -07:00
|
|
|
struct gb_operation *operation;
|
|
|
|
|
2014-12-02 07:30:32 -07:00
|
|
|
operation = gb_operation_create_common(connection, 0, request_size, 0);
|
2014-12-02 07:30:28 -07:00
|
|
|
if (operation) {
|
2014-12-02 07:30:32 -07:00
|
|
|
operation->id = id;
|
2014-12-02 07:30:28 -07:00
|
|
|
memcpy(operation->request->header, data, request_size);
|
|
|
|
}
|
|
|
|
|
|
|
|
return operation;
|
2014-11-19 16:55:02 -07:00
|
|
|
}
|
|
|
|
|
2014-11-21 18:29:15 -07:00
|
|
|
/*
|
|
|
|
* Get an additional reference on an operation.
|
|
|
|
*/
|
|
|
|
void gb_operation_get(struct gb_operation *operation)
|
|
|
|
{
|
|
|
|
kref_get(&operation->kref);
|
|
|
|
}
|
|
|
|
|
2014-10-01 20:54:15 -06:00
|
|
|
/*
|
|
|
|
* Destroy a previously created operation.
|
|
|
|
*/
|
2014-11-17 07:08:40 -07:00
|
|
|
static void _gb_operation_destroy(struct kref *kref)
|
2014-10-01 20:54:15 -06:00
|
|
|
{
|
2014-11-17 07:08:40 -07:00
|
|
|
struct gb_operation *operation;
|
|
|
|
|
|
|
|
operation = container_of(kref, struct gb_operation, kref);
|
2014-10-01 20:54:15 -06:00
|
|
|
|
|
|
|
/* 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-11-20 15:09:15 -07:00
|
|
|
gb_operation_message_free(operation->response);
|
|
|
|
gb_operation_message_free(operation->request);
|
2014-10-01 20:54:15 -06:00
|
|
|
|
2014-10-20 09:27:56 -06:00
|
|
|
kmem_cache_free(gb_operation_cache, operation);
|
2014-10-01 20:54:15 -06:00
|
|
|
}
|
2014-10-16 05:35:33 -06:00
|
|
|
|
2014-11-21 18:29:15 -07:00
|
|
|
/*
|
|
|
|
* Drop a reference on an operation, and destroy it when the last
|
|
|
|
* one is gone.
|
|
|
|
*/
|
2014-11-17 07:08:40 -07:00
|
|
|
void gb_operation_put(struct gb_operation *operation)
|
|
|
|
{
|
|
|
|
if (!WARN_ON(!operation))
|
|
|
|
kref_put(&operation->kref, _gb_operation_destroy);
|
|
|
|
}
|
|
|
|
|
2014-11-21 18:29:20 -07:00
|
|
|
/* Tell the requester we're done */
|
|
|
|
static void gb_operation_sync_callback(struct gb_operation *operation)
|
|
|
|
{
|
|
|
|
complete(&operation->completion);
|
|
|
|
}
|
|
|
|
|
2014-10-16 05:35:33 -06: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
|
2014-11-21 18:29:20 -07:00
|
|
|
* message has arrived indicating the operation is complete. In
|
2014-11-25 10:33:13 -07:00
|
|
|
* that case, the callback function is responsible for fetching the
|
|
|
|
* result of the operation using gb_operation_result() if desired,
|
|
|
|
* and dropping the final reference to (i.e., destroying) the
|
|
|
|
* operation. A null callback function is used for a synchronous
|
|
|
|
* request; in that case return from this function won't occur until
|
|
|
|
* the operation is complete.
|
2014-10-16 05:35:33 -06:00
|
|
|
*/
|
|
|
|
int gb_operation_request_send(struct gb_operation *operation,
|
|
|
|
gb_operation_callback callback)
|
|
|
|
{
|
2014-11-12 14:17:52 -07:00
|
|
|
unsigned long timeout;
|
2014-10-16 05:35:33 -06:00
|
|
|
int ret;
|
|
|
|
|
2014-10-22 01:04:30 -06:00
|
|
|
if (operation->connection->state != GB_CONNECTION_STATE_ENABLED)
|
|
|
|
return -ENOTCONN;
|
|
|
|
|
2014-10-16 05:35:33 -06:00
|
|
|
/*
|
2014-11-21 18:29:15 -07:00
|
|
|
* First, get an extra reference on the operation.
|
|
|
|
* It'll be dropped when the operation completes.
|
2014-10-16 05:35:33 -06:00
|
|
|
*/
|
2014-11-21 18:29:15 -07:00
|
|
|
gb_operation_get(operation);
|
|
|
|
|
2014-11-21 18:29:20 -07:00
|
|
|
/* A null callback pointer means synchronous return */
|
|
|
|
if (callback)
|
|
|
|
operation->callback = callback;
|
|
|
|
else
|
|
|
|
operation->callback = gb_operation_sync_callback;
|
2014-11-12 14:17:53 -07:00
|
|
|
gb_pending_operation_insert(operation);
|
2014-11-20 14:37:06 -07:00
|
|
|
|
|
|
|
/*
|
|
|
|
* We impose a time limit for requests to complete. We need
|
|
|
|
* to set the timer before we send the request though, so we
|
|
|
|
* don't lose a race with the receipt of the resposne.
|
|
|
|
*/
|
|
|
|
timeout = msecs_to_jiffies(OPERATION_TIMEOUT_DEFAULT);
|
|
|
|
schedule_delayed_work(&operation->timeout_work, timeout);
|
|
|
|
|
|
|
|
/* All set, send the request */
|
2014-11-25 10:33:15 -07:00
|
|
|
gb_operation_result_set(operation, -EINPROGRESS);
|
2014-12-01 06:53:10 -07:00
|
|
|
ret = gb_message_send(operation->request);
|
2014-11-21 18:29:12 -07:00
|
|
|
if (ret || callback)
|
2014-10-16 05:35:33 -06:00
|
|
|
return ret;
|
2014-11-12 14:17:52 -07:00
|
|
|
|
2014-11-21 18:29:19 -07:00
|
|
|
/* Cancel the operation if interrupted */
|
|
|
|
ret = wait_for_completion_interruptible(&operation->completion);
|
|
|
|
if (ret < 0)
|
2014-11-25 12:06:44 -07:00
|
|
|
gb_operation_cancel(operation, -ECANCELED);
|
2014-11-21 18:29:19 -07:00
|
|
|
|
2014-11-25 10:33:13 -07:00
|
|
|
return gb_operation_result(operation);
|
2014-10-16 05:35:33 -06:00
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Send a response for an incoming operation request.
|
|
|
|
*/
|
2014-12-02 07:30:36 -07:00
|
|
|
int gb_operation_response_send(struct gb_operation *operation, int errno)
|
2014-10-16 05:35:33 -06:00
|
|
|
{
|
2014-12-02 07:30:36 -07:00
|
|
|
/* Record the result */
|
|
|
|
if (!gb_operation_result_set(operation, errno)) {
|
|
|
|
pr_err("request result already set\n");
|
|
|
|
return -EIO; /* Shouldn't happen */
|
|
|
|
}
|
2014-10-16 05:35:33 -06:00
|
|
|
gb_operation_destroy(operation);
|
|
|
|
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
2014-11-20 15:09:17 -07:00
|
|
|
/*
|
|
|
|
* This function is called when a buffer send request has completed.
|
|
|
|
* The "header" is the message header--the beginning of what we
|
|
|
|
* asked to have sent.
|
|
|
|
*/
|
|
|
|
void
|
|
|
|
greybus_data_sent(struct greybus_host_device *hd, void *header, int status)
|
|
|
|
{
|
|
|
|
struct gb_message *message;
|
|
|
|
struct gb_operation *operation;
|
|
|
|
|
2014-12-02 07:30:37 -07:00
|
|
|
/* Get the message and record that it is no longer in flight */
|
2014-11-25 15:54:04 -07:00
|
|
|
message = gb_hd_message_find(hd, header);
|
|
|
|
message->cookie = NULL;
|
|
|
|
|
2014-12-02 07:30:37 -07:00
|
|
|
/*
|
|
|
|
* If the message was a response, we just need to drop our
|
|
|
|
* reference to the operation. If an error occurred, report
|
|
|
|
* it.
|
|
|
|
*
|
|
|
|
* For requests, if there's no error, there's nothing more
|
|
|
|
* to do until the response arrives. If an error occurred
|
|
|
|
* attempting to send it, record that as the result of
|
|
|
|
* the operation and schedule its completion.
|
|
|
|
*/
|
2014-11-20 15:09:17 -07:00
|
|
|
operation = message->operation;
|
2014-12-02 07:30:37 -07:00
|
|
|
if (message == operation->response) {
|
|
|
|
if (status)
|
|
|
|
pr_err("error %d sending response\n", status);
|
|
|
|
gb_operation_put(operation);
|
|
|
|
} else if (status) {
|
|
|
|
if (gb_operation_result_set(operation, status))
|
|
|
|
queue_work(gb_operation_workqueue, &operation->work);
|
|
|
|
}
|
2014-11-20 15:09:17 -07:00
|
|
|
}
|
|
|
|
EXPORT_SYMBOL_GPL(greybus_data_sent);
|
|
|
|
|
2014-10-16 05:35:34 -06:00
|
|
|
/*
|
2014-11-19 11:27:17 -07:00
|
|
|
* We've received data on a connection, and it doesn't look like a
|
|
|
|
* response, so we assume it's a request.
|
2014-11-17 07:08:39 -07:00
|
|
|
*
|
|
|
|
* This is called in interrupt context, so just copy the incoming
|
2014-11-19 11:27:17 -07:00
|
|
|
* data into the request buffer and handle the rest via workqueue.
|
|
|
|
*/
|
2014-12-01 21:42:20 -07:00
|
|
|
static void gb_connection_recv_request(struct gb_connection *connection,
|
2014-12-02 07:30:32 -07:00
|
|
|
u16 operation_id, void *data,
|
2014-12-01 21:42:20 -07:00
|
|
|
size_t size)
|
2014-11-19 11:27:17 -07:00
|
|
|
{
|
|
|
|
struct gb_operation *operation;
|
|
|
|
|
2014-12-02 07:30:28 -07:00
|
|
|
operation = gb_operation_create_incoming(connection, operation_id,
|
2014-12-02 07:30:32 -07:00
|
|
|
data, size);
|
2014-11-19 11:27:17 -07:00
|
|
|
if (!operation) {
|
|
|
|
gb_connection_err(connection, "can't create operation");
|
|
|
|
return; /* XXX Respond with pre-allocated ENOMEM */
|
|
|
|
}
|
|
|
|
|
2014-12-02 07:30:37 -07:00
|
|
|
/*
|
|
|
|
* Incoming requests are handled by arranging for the
|
|
|
|
* request handler to be the operation's callback function.
|
|
|
|
*
|
|
|
|
* The last thing the handler does is send a response
|
|
|
|
* message. The callback function is then cleared (in
|
|
|
|
* gb_operation_work()). The original reference to the
|
|
|
|
* operation will be dropped when the response has been
|
|
|
|
* sent.
|
|
|
|
*/
|
|
|
|
operation->callback = gb_operation_request_handle;
|
|
|
|
if (gb_operation_result_set(operation, -EINPROGRESS))
|
2014-11-25 10:33:14 -07:00
|
|
|
queue_work(gb_operation_workqueue, &operation->work);
|
2014-11-19 11:27:17 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
|
|
|
* We've received data that appears to be an operation response
|
|
|
|
* message. Look up the operation, and record that we've received
|
2014-11-20 22:56:30 -07:00
|
|
|
* its response.
|
2014-11-17 07:08:39 -07:00
|
|
|
*
|
2014-11-19 11:27:17 -07:00
|
|
|
* This is called in interrupt context, so just copy the incoming
|
|
|
|
* data into the response buffer and handle the rest via workqueue.
|
|
|
|
*/
|
|
|
|
static void gb_connection_recv_response(struct gb_connection *connection,
|
2014-12-02 07:30:30 -07:00
|
|
|
u16 operation_id, u8 result, void *data, size_t size)
|
2014-11-19 11:27:17 -07:00
|
|
|
{
|
|
|
|
struct gb_operation *operation;
|
|
|
|
struct gb_message *message;
|
2014-12-02 07:30:30 -07:00
|
|
|
int errno = gb_operation_status_map(result);
|
2014-11-19 11:27:17 -07:00
|
|
|
|
|
|
|
operation = gb_pending_operation_find(connection, operation_id);
|
|
|
|
if (!operation) {
|
|
|
|
gb_connection_err(connection, "operation not found");
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
cancel_delayed_work(&operation->timeout_work);
|
|
|
|
gb_pending_operation_remove(operation);
|
|
|
|
|
2014-11-20 15:09:15 -07:00
|
|
|
message = operation->response;
|
2014-12-02 07:30:30 -07:00
|
|
|
if (!errno && size != message->size) {
|
2014-11-25 12:06:45 -07:00
|
|
|
gb_connection_err(connection, "bad message size (%zu != %zu)",
|
|
|
|
size, message->size);
|
2014-12-02 07:30:30 -07:00
|
|
|
errno = -EMSGSIZE;
|
2014-11-19 11:27:17 -07:00
|
|
|
}
|
|
|
|
|
2014-11-19 16:55:05 -07:00
|
|
|
/* We must ignore the payload if a bad status is returned */
|
2014-12-02 07:30:30 -07:00
|
|
|
if (errno)
|
2014-12-02 07:30:29 -07:00
|
|
|
size = sizeof(*message->header);
|
|
|
|
memcpy(message->header, data, size);
|
2014-11-19 11:27:17 -07:00
|
|
|
|
|
|
|
/* The rest will be handled in work queue context */
|
2014-12-02 07:30:30 -07:00
|
|
|
if (gb_operation_result_set(operation, errno))
|
2014-11-25 10:33:14 -07:00
|
|
|
queue_work(gb_operation_workqueue, &operation->work);
|
2014-11-19 11:27:17 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Handle data arriving on a connection. As soon as we return the
|
|
|
|
* supplied data buffer will be reused (so unless we do something
|
|
|
|
* with, it's effectively dropped).
|
2014-10-16 05:35:34 -06:00
|
|
|
*/
|
2014-11-18 12:26:50 -07:00
|
|
|
void gb_connection_recv(struct gb_connection *connection,
|
2014-10-16 05:35:33 -06:00
|
|
|
void *data, size_t size)
|
|
|
|
{
|
|
|
|
struct gb_operation_msg_hdr *header;
|
2014-11-19 11:27:17 -07:00
|
|
|
size_t msg_size;
|
|
|
|
u16 operation_id;
|
2014-10-16 05:35:33 -06:00
|
|
|
|
2014-11-19 11:27:17 -07:00
|
|
|
if (connection->state != GB_CONNECTION_STATE_ENABLED) {
|
|
|
|
gb_connection_err(connection, "dropping %zu received bytes",
|
|
|
|
size);
|
2014-10-22 01:04:30 -06:00
|
|
|
return;
|
2014-11-19 11:27:17 -07:00
|
|
|
}
|
2014-10-22 01:04:30 -06:00
|
|
|
|
2014-11-17 07:08:39 -07:00
|
|
|
if (size < sizeof(*header)) {
|
|
|
|
gb_connection_err(connection, "message too small");
|
2014-10-16 05:35:33 -06:00
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
header = data;
|
2014-11-19 11:27:17 -07:00
|
|
|
msg_size = (size_t)le16_to_cpu(header->size);
|
|
|
|
if (msg_size > size) {
|
|
|
|
gb_connection_err(connection, "incomplete message");
|
|
|
|
return; /* XXX Should still complete operation */
|
2014-10-16 05:35:33 -06:00
|
|
|
}
|
|
|
|
|
2014-11-19 11:27:17 -07:00
|
|
|
operation_id = le16_to_cpu(header->operation_id);
|
|
|
|
if (header->type & GB_OPERATION_TYPE_RESPONSE)
|
|
|
|
gb_connection_recv_response(connection, operation_id,
|
2014-12-02 07:30:30 -07:00
|
|
|
header->result, data, msg_size);
|
2014-11-19 11:27:17 -07:00
|
|
|
else
|
|
|
|
gb_connection_recv_request(connection, operation_id,
|
2014-12-02 07:30:32 -07:00
|
|
|
data, msg_size);
|
2014-10-16 05:35:34 -06:00
|
|
|
}
|
|
|
|
|
2014-10-22 01:04:29 -06:00
|
|
|
/*
|
2014-11-21 18:29:17 -07:00
|
|
|
* Cancel an operation, and record the given error to indicate why.
|
2014-10-22 01:04:29 -06:00
|
|
|
*/
|
2014-11-21 18:29:17 -07:00
|
|
|
void gb_operation_cancel(struct gb_operation *operation, int errno)
|
2014-10-22 01:04:29 -06:00
|
|
|
{
|
2014-11-25 10:33:14 -07:00
|
|
|
if (gb_operation_result_set(operation, errno)) {
|
|
|
|
gb_message_cancel(operation->request);
|
|
|
|
gb_message_cancel(operation->response);
|
|
|
|
}
|
2014-10-22 01:04:29 -06:00
|
|
|
}
|
|
|
|
|
2014-11-24 12:19:13 -07:00
|
|
|
/**
|
|
|
|
* gb_operation_sync: implement a "simple" synchronous gb operation.
|
|
|
|
* @connection: the Greybus connection to send this to
|
|
|
|
* @type: the type of operation to send
|
|
|
|
* @request: pointer to a memory buffer to copy the request from
|
|
|
|
* @request_size: size of @request
|
|
|
|
* @response: pointer to a memory buffer to copy the response to
|
|
|
|
* @response_size: the size of @response.
|
|
|
|
*
|
|
|
|
* This function implements a simple synchronous Greybus operation. It sends
|
|
|
|
* the provided operation request and waits (sleeps) until the corresponding
|
|
|
|
* operation response message has been successfully received, or an error
|
|
|
|
* occurs. @request and @response are buffers to hold the request and response
|
|
|
|
* data respectively, and if they are not NULL, their size must be specified in
|
|
|
|
* @request_size and @response_size.
|
|
|
|
*
|
|
|
|
* If a response payload is to come back, and @response is not NULL,
|
|
|
|
* @response_size number of bytes will be copied into @response if the operation
|
|
|
|
* is successful.
|
|
|
|
*
|
|
|
|
* If there is an error, the response buffer is left alone.
|
|
|
|
*/
|
|
|
|
int gb_operation_sync(struct gb_connection *connection, int type,
|
|
|
|
void *request, int request_size,
|
|
|
|
void *response, int response_size)
|
|
|
|
{
|
|
|
|
struct gb_operation *operation;
|
|
|
|
int ret;
|
|
|
|
|
|
|
|
if ((response_size && !response) ||
|
|
|
|
(request_size && !request))
|
|
|
|
return -EINVAL;
|
|
|
|
|
|
|
|
operation = gb_operation_create(connection, type,
|
|
|
|
request_size, response_size);
|
|
|
|
if (!operation)
|
|
|
|
return -ENOMEM;
|
|
|
|
|
|
|
|
if (request_size)
|
|
|
|
memcpy(&operation->request->payload, request, request_size);
|
|
|
|
|
|
|
|
/* Synchronous operation--no callback */
|
|
|
|
ret = gb_operation_request_send(operation, NULL);
|
|
|
|
if (ret)
|
|
|
|
pr_err("version operation failed (%d)\n", ret);
|
|
|
|
else
|
|
|
|
if (response_size)
|
|
|
|
memcpy(response, operation->response->payload,
|
|
|
|
response_size);
|
|
|
|
gb_operation_destroy(operation);
|
|
|
|
|
|
|
|
return ret;
|
|
|
|
}
|
|
|
|
|
2014-10-16 05:35:34 -06:00
|
|
|
int gb_operation_init(void)
|
|
|
|
{
|
2014-12-02 07:30:35 -07:00
|
|
|
size_t size;
|
|
|
|
|
2014-12-01 06:53:07 -07:00
|
|
|
BUILD_BUG_ON(GB_OPERATION_MESSAGE_SIZE_MAX >
|
|
|
|
U16_MAX - sizeof(struct gb_operation_msg_hdr));
|
|
|
|
|
2014-12-02 07:30:35 -07:00
|
|
|
/*
|
|
|
|
* A message structure with consists of:
|
|
|
|
* - the message structure itself
|
|
|
|
* - the headroom set aside for the host device
|
|
|
|
* - the message header
|
|
|
|
* - space for the message payload
|
|
|
|
* Messages with no payload are a fairly common case and
|
|
|
|
* have a known fixed maximum size, so we use a slab cache
|
|
|
|
* for them.
|
|
|
|
*/
|
|
|
|
size = sizeof(struct gb_message) + GB_BUFFER_HEADROOM_MAX +
|
|
|
|
sizeof(struct gb_operation_msg_hdr);
|
|
|
|
gb_simple_message_cache = kmem_cache_create("gb_simple_message_cache",
|
|
|
|
size, 0, 0, NULL);
|
|
|
|
if (!gb_simple_message_cache)
|
|
|
|
return -ENOMEM;
|
|
|
|
|
2014-10-20 09:27:56 -06:00
|
|
|
gb_operation_cache = kmem_cache_create("gb_operation_cache",
|
|
|
|
sizeof(struct gb_operation), 0, 0, NULL);
|
|
|
|
if (!gb_operation_cache)
|
2014-12-02 07:30:35 -07:00
|
|
|
goto err_simple;
|
2014-10-20 09:27:56 -06:00
|
|
|
|
2014-11-21 18:29:13 -07:00
|
|
|
gb_operation_workqueue = alloc_workqueue("greybus_operation", 0, 1);
|
2014-12-02 07:30:35 -07:00
|
|
|
if (!gb_operation_workqueue)
|
|
|
|
goto err_operation;
|
2014-10-16 05:35:34 -06:00
|
|
|
|
|
|
|
return 0;
|
2014-12-02 07:30:35 -07:00
|
|
|
err_operation:
|
|
|
|
kmem_cache_destroy(gb_operation_cache);
|
|
|
|
gb_operation_cache = NULL;
|
|
|
|
err_simple:
|
|
|
|
kmem_cache_destroy(gb_simple_message_cache);
|
|
|
|
gb_simple_message_cache = NULL;
|
|
|
|
|
|
|
|
return -ENOMEM;
|
2014-10-16 05:35:34 -06:00
|
|
|
}
|
|
|
|
|
|
|
|
void gb_operation_exit(void)
|
|
|
|
{
|
2014-11-21 18:29:13 -07:00
|
|
|
destroy_workqueue(gb_operation_workqueue);
|
|
|
|
gb_operation_workqueue = NULL;
|
2014-11-14 04:55:00 -07:00
|
|
|
kmem_cache_destroy(gb_operation_cache);
|
|
|
|
gb_operation_cache = NULL;
|
2014-12-02 07:30:35 -07:00
|
|
|
kmem_cache_destroy(gb_simple_message_cache);
|
|
|
|
gb_simple_message_cache = NULL;
|
2014-10-16 05:35:33 -06:00
|
|
|
}
|