1/*
  2 * udc.h - ChipIdea UDC structures
  3 *
  4 * Copyright (C) 2008 Chipidea - MIPS Technologies, Inc. All rights reserved.
  5 *
  6 * Author: David Lopo
  7 *
  8 * This program is free software; you can redistribute it and/or modify
  9 * it under the terms of the GNU General Public License version 2 as
 10 * published by the Free Software Foundation.
 11 */
 12
 13#ifndef __DRIVERS_USB_CHIPIDEA_UDC_H
 14#define __DRIVERS_USB_CHIPIDEA_UDC_H
 15
 16#include <linux/list.h>
 17
 18#define CTRL_PAYLOAD_MAX   64
 19#define RX        0  /* similar to USB_DIR_OUT but can be used as an index */
 20#define TX        1  /* similar to USB_DIR_IN  but can be used as an index */
 21
 22/* DMA layout of transfer descriptors */
 23struct ci_hw_td {
 24	/* 0 */
 25	__le32 next;
 26#define TD_TERMINATE          BIT(0)
 27#define TD_ADDR_MASK          (0xFFFFFFEUL << 5)
 28	/* 1 */
 29	__le32 token;
 30#define TD_STATUS             (0x00FFUL <<  0)
 31#define TD_STATUS_TR_ERR      BIT(3)
 32#define TD_STATUS_DT_ERR      BIT(5)
 33#define TD_STATUS_HALTED      BIT(6)
 34#define TD_STATUS_ACTIVE      BIT(7)
 35#define TD_MULTO              (0x0003UL << 10)
 36#define TD_IOC                BIT(15)
 37#define TD_TOTAL_BYTES        (0x7FFFUL << 16)
 38	/* 2 */
 39	__le32 page[5];
 40#define TD_CURR_OFFSET        (0x0FFFUL <<  0)
 41#define TD_FRAME_NUM          (0x07FFUL <<  0)
 42#define TD_RESERVED_MASK      (0x0FFFUL <<  0)
 43} __attribute__ ((packed, aligned(4)));
 44
 45/* DMA layout of queue heads */
 46struct ci_hw_qh {
 47	/* 0 */
 48	__le32 cap;
 49#define QH_IOS                BIT(15)
 50#define QH_MAX_PKT            (0x07FFUL << 16)
 51#define QH_ZLT                BIT(29)
 52#define QH_MULT               (0x0003UL << 30)
 53#define QH_ISO_MULT(x)		((x >> 11) & 0x03)
 54	/* 1 */
 55	__le32 curr;
 56	/* 2 - 8 */
 57	struct ci_hw_td		td;
 58	/* 9 */
 59	__le32 RESERVED;
 60	struct usb_ctrlrequest   setup;
 61} __attribute__ ((packed, aligned(4)));
 62
 63struct td_node {
 64	struct list_head	td;
 65	dma_addr_t		dma;
 66	struct ci_hw_td		*ptr;
 67};
 68
 69/**
 70 * struct ci_hw_req - usb request representation
 71 * @req: request structure for gadget drivers
 72 * @queue: link to QH list
 73 * @ptr: transfer descriptor for this request
 74 * @dma: dma address for the transfer descriptor
 75 * @zptr: transfer descriptor for the zero packet
 76 * @zdma: dma address of the zero packet's transfer descriptor
 77 */
 78struct ci_hw_req {
 79	struct usb_request	req;
 80	struct list_head	queue;
 81	struct list_head	tds;
 82};
 83
 84#ifdef CONFIG_USB_CHIPIDEA_UDC
 85
 86int ci_hdrc_gadget_init(struct ci_hdrc *ci);
 87void ci_hdrc_gadget_destroy(struct ci_hdrc *ci);
 88
 89#else
 90
 91static inline int ci_hdrc_gadget_init(struct ci_hdrc *ci)
 92{
 93	return -ENXIO;
 94}
 95
 96static inline void ci_hdrc_gadget_destroy(struct ci_hdrc *ci)
 97{
 98
 99}
100
101#endif
102
103#endif /* __DRIVERS_USB_CHIPIDEA_UDC_H */