source: mainline/uspace/lib/usb/hcd.h@ 7034be15

/*
 * Copyright (c) 2010 Vojtech Horky
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/** @addtogroup libusb usb
 * @{
 */
/** @file
 * @brief USB Host Controller Driver.
 */
#ifndef LIBUSB_HCD_H_
#define LIBUSB_HCD_H_

#include "usb.h"

#include <ipc/ipc.h>
#include <async.h>

/** Maximum size of transaction payload. */
#define USB_MAX_PAYLOAD_SIZE 1020

/** Opaque handle of active USB transaction.
 * This handle is when informing about transaction outcome (or status).
 */
typedef ipcarg_t usb_transaction_handle_t;


/** USB packet identifier. */
typedef enum {
#define _MAKE_PID_NIBBLE(tag, type) \
        ((uint8_t)(((tag) << 2) | (type)))
#define _MAKE_PID(tag, type) \
        ( \
            _MAKE_PID_NIBBLE(tag, type) \
            | ((~_MAKE_PID_NIBBLE(tag, type)) << 4) \
        )
        USB_PID_OUT = _MAKE_PID(0, 1),
        USB_PID_IN = _MAKE_PID(2, 1),
        USB_PID_SOF = _MAKE_PID(1, 1),
        USB_PID_SETUP = _MAKE_PID(3, 1),
        
        USB_PID_DATA0 = _MAKE_PID(0 ,3),
        USB_PID_DATA1 = _MAKE_PID(2 ,3),
        
        USB_PID_ACK = _MAKE_PID(0 ,2),
        USB_PID_NAK = _MAKE_PID(2 ,2),
        USB_PID_STALL = _MAKE_PID(3 ,2),
        
        USB_PID_PRE = _MAKE_PID(3 ,0),
        /* USB_PID_ = _MAKE_PID( ,), */
#undef _MAKE_PID
#undef _MAKE_PID_NIBBLE
} usb_packet_id;

/** IPC methods for HCD.
 *
 * Notes for async methods:
 *
 * Methods for sending data to device (OUT transactions)
 * - e.g. IPC_M_USB_HCD_INTERRUPT_OUT_ASYNC -
 * always use the same semantics:
 * - first, IPC call with given method is made
 *   - argument #1 is target address
 *   - argument #2 is target endpoint
 *   - argument #3 is buffer size
 * - this call is immediately followed by IPC data write (from caller)
 * - the initial call (and the whole transaction) is answer after the
 *   transaction is scheduled by the HC and acknowledged by the device
 *   or immediatelly after error is detected
 * - the answer carries only the error code
 *
 * Methods for retrieving data from device (IN transactions)
 * - e.g. IPC_M_USB_HCD_INTERRUPT_IN_ASYNC -
 * also use the same semantics:
 * - first, IPC call with given method is made
 *   - argument #1 is target address
 *   - argument #2 is target endpoint
 *   - argument #3 is buffer size
 * - the call is not answered until the device returns some data (or until
 *   error occurs)
 * - if the call is answered with EOK, first argument of the answer is buffer
 *   hash that could be used to retrieve the actual data
 *
 * Some special methods (NO-DATA transactions) do not send any data. These
 * might behave as both OUT or IN transactions because communication parts
 * where actual buffers are exchanged are ommitted.
 *
 * The mentioned data retrieval can be done any time after receiving EOK
 * answer to IN method.
 * This retrieval is done using the IPC_M_USB_HCD_GET_BUFFER_ASYNC where
 * the first argument is buffer hash from call answer.
 * This call must be immediatelly followed by data read-in and after the
 * data are transferred, the initial call (IPC_M_USB_HCD_GET_BUFFER_ASYNC)
 * is answered. Each buffer can be retrieved only once.
 *
 * For all these methods, wrap functions exists. Important rule: functions
 * for IN transactions have (as parameters) buffers where retrieved data
 * will be stored. These buffers must be already allocated and shall not be
 * touch until the transaction is completed
 * (e.g. not before calling usb_hcd_async_wait_for() with appropriate handle).
 * OUT transactions buffers can be freed immediatelly after call is dispatched
 * (i.e. after return from wrapping function).
 *
 */
typedef enum {
        /** Tell maximum size of the transaction buffer (payload).
         * 
         * Arguments of the call:
         *  (none)
         * 
         * Answer:
         * - EOK - always
         * 
         * Arguments of the answer:
         * - buffer size (in bytes):
         */
        IPC_M_USB_HCD_TRANSACTION_SIZE = IPC_FIRST_USER_METHOD,
        
        /** Asks for data buffer.
         * See explanation at usb_hcd_method_t.
         */
        IPC_M_USB_HCD_GET_BUFFER_ASYNC,
        
        
        
        /** Send interrupt data to device.
         * See explanation at usb_hcd_method_t (OUT transaction).
         */
        IPC_M_USB_HCD_INTERRUPT_OUT_ASYNC,
        
        /** Get interrupt data from device.
         * See explanation at usb_hcd_method_t (IN transaction).
         */
        IPC_M_USB_HCD_INTERRUPT_IN_ASYNC,
        
        
        /** Start WRITE control transfer.
         * See explanation at usb_hcd_method_t (OUT transaction).
         */
        IPC_M_USB_HCD_CONTROL_WRITE_SETUP_ASYNC,
        
        /** Send control-transfer data to device.
         * See explanation at usb_hcd_method_t (OUT transaction).
         */
        IPC_M_USB_HCD_CONTROL_WRITE_DATA_ASYNC,
        
        /** Terminate WRITE control transfer.
         * See explanation at usb_hcd_method_t (NO-DATA transaction).
         */
        IPC_M_USB_HCD_CONTROL_WRITE_STATUS_ASYNC,
        
        
        
        /** Start READ control transfer.
         * See explanation at usb_hcd_method_t (OUT transaction).
         */
        IPC_M_USB_HCD_CONTROL_READ_SETUP_ASYNC,
        
        /** Get control-transfer data from device.
         * See explanation at usb_hcd_method_t (IN transaction).
         */
        IPC_M_USB_HCD_CONTROL_READ_DATA_ASYNC,
        
        /** Terminate READ control transfer.
         * See explanation at usb_hcd_method_t (NO-DATA transaction).
         */
        IPC_M_USB_HCD_CONTROL_READ_STATUS_ASYNC,
        
        
        /* IPC_M_USB_HCD_ */
} usb_hcd_method_t;

/** IPC methods for callbacks from HCD. */
typedef enum {
        /** Confimation after data sent.
         * 
         * Arguments of the call:
         * - transaction handle
         * - transaction outcome
         */
        IPC_M_USB_HCD_DATA_SENT = IPC_FIRST_USER_METHOD,
        
        /** Notification of data received.
         * This call initiates sending a data buffer from HCD to the client.
         * See IPC_M_USB_HCD_SEND_DATA for details for buffer transfer is
         * done.
         * 
         * Arguments of the call:
         * - transaction handle
         * - transaction outcome
         * - actual data length
         */
        IPC_M_USB_HCD_DATA_RECEIVED,
        
        /** Notification about a serious trouble with HC.
         */
        IPC_M_USB_HCD_CONTROLLER_FAILURE,
        
        /* IPC_M_USB_HCD_ */
} usb_hcd_callback_method_t;


int usb_hcd_connect(const char *);

int usb_hcd_async_transfer_interrupt_out(int, usb_target_t,
    void *, size_t, usb_handle_t *);
int usb_hcd_async_transfer_interrupt_in(int, usb_target_t,
    void *, size_t, size_t *, usb_handle_t *);

int usb_hcd_async_transfer_control_write_setup(int, usb_target_t,
    void *, size_t, usb_handle_t *);
int usb_hcd_async_transfer_control_write_data(int, usb_target_t,
    void *, size_t, usb_handle_t *);
int usb_hcd_async_transfer_control_write_status(int, usb_target_t,
    usb_handle_t *);

int usb_hcd_async_transfer_control_read_setup(int, usb_target_t,
    void *, size_t, usb_handle_t *);
int usb_hcd_async_transfer_control_read_data(int, usb_target_t,
    void *, size_t, size_t *, usb_handle_t *);
int usb_hcd_async_transfer_control_read_status(int, usb_target_t,
    usb_handle_t *);

int usb_hcd_async_wait_for(usb_handle_t);

#endif
/**
 * @}
 */