[mirror_ubuntu-focal-kernel.git] / drivers / usb / chipidea / udc.h

/*
 * udc.h - ChipIdea UDC structures
 *
 * Copyright (C) 2008 Chipidea - MIPS Technologies, Inc. All rights reserved.
 *
 * Author: David Lopo
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */

#ifndef __DRIVERS_USB_CHIPIDEA_UDC_H
#define __DRIVERS_USB_CHIPIDEA_UDC_H

#include <linux/list.h>

#define CTRL_PAYLOAD_MAX   64
#define RX        0  /* similar to USB_DIR_OUT but can be used as an index */
#define TX        1  /* similar to USB_DIR_IN  but can be used as an index */

/* DMA layout of transfer descriptors */
struct ci13xxx_td {
	/* 0 */
	u32 next;
#define TD_TERMINATE          BIT(0)
#define TD_ADDR_MASK          (0xFFFFFFEUL << 5)
	/* 1 */
	u32 token;
#define TD_STATUS             (0x00FFUL <<  0)
#define TD_STATUS_TR_ERR      BIT(3)
#define TD_STATUS_DT_ERR      BIT(5)
#define TD_STATUS_HALTED      BIT(6)
#define TD_STATUS_ACTIVE      BIT(7)
#define TD_MULTO              (0x0003UL << 10)
#define TD_IOC                BIT(15)
#define TD_TOTAL_BYTES        (0x7FFFUL << 16)
	/* 2 */
	u32 page[5];
#define TD_CURR_OFFSET        (0x0FFFUL <<  0)
#define TD_FRAME_NUM          (0x07FFUL <<  0)
#define TD_RESERVED_MASK      (0x0FFFUL <<  0)
} __attribute__ ((packed));

/* DMA layout of queue heads */
struct ci13xxx_qh {
	/* 0 */
	u32 cap;
#define QH_IOS                BIT(15)
#define QH_MAX_PKT            (0x07FFUL << 16)
#define QH_ZLT                BIT(29)
#define QH_MULT               (0x0003UL << 30)
	/* 1 */
	u32 curr;
	/* 2 - 8 */
	struct ci13xxx_td        td;
	/* 9 */
	u32 RESERVED;
	struct usb_ctrlrequest   setup;
} __attribute__ ((packed));

/**
 * struct ci13xxx_req - usb request representation
 * @req: request structure for gadget drivers
 * @queue: link to QH list
 * @ptr: transfer descriptor for this request
 * @dma: dma address for the transfer descriptor
 * @zptr: transfer descriptor for the zero packet
 * @zdma: dma address of the zero packet's transfer descriptor
 */
struct ci13xxx_req {
	struct usb_request	req;
	struct list_head	queue;
	struct ci13xxx_td	*ptr;
	dma_addr_t		dma;
	struct ci13xxx_td	*zptr;
	dma_addr_t		zdma;
};

#ifdef CONFIG_USB_CHIPIDEA_UDC

int ci_hdrc_gadget_init(struct ci13xxx *ci);

#else

static inline int ci_hdrc_gadget_init(struct ci13xxx *ci)
{
	return -ENXIO;
}

#endif

#endif /* __DRIVERS_USB_CHIPIDEA_UDC_H */
Commit	Line	Data
e443b333 AS	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 */
	23	struct ci13xxx_td {
	24	/* 0 */
	25	u32 next;
	26	#define TD_TERMINATE BIT(0)
	27	#define TD_ADDR_MASK (0xFFFFFFEUL << 5)
	28	/* 1 */
	29	u32 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	u32 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));
	44
	45	/* DMA layout of queue heads */
	46	struct ci13xxx_qh {
	47	/* 0 */
	48	u32 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	/* 1 */
	54	u32 curr;
	55	/* 2 - 8 */
	56	struct ci13xxx_td td;
	57	/* 9 */
	58	u32 RESERVED;
	59	struct usb_ctrlrequest setup;
	60	} __attribute__ ((packed));
	61
551a8ac6 AS	62	/**
	63	* struct ci13xxx_req - usb request representation
	64	* @req: request structure for gadget drivers
551a8ac6 AS	65	* @queue: link to QH list
	66	* @ptr: transfer descriptor for this request
	67	* @dma: dma address for the transfer descriptor
	68	* @zptr: transfer descriptor for the zero packet
	69	* @zdma: dma address of the zero packet's transfer descriptor
	70	*/
e443b333	71	struct ci13xxx_req {
551a8ac6	72	struct usb_request req;
551a8ac6 AS	73	struct list_head queue;
	74	struct ci13xxx_td *ptr;
	75	dma_addr_t dma;
	76	struct ci13xxx_td *zptr;
	77	dma_addr_t zdma;
e443b333 AS	78	};
	79
	80	#ifdef CONFIG_USB_CHIPIDEA_UDC
5f36e231 AS	81
	82	int ci_hdrc_gadget_init(struct ci13xxx *ci);
	83
e443b333	84	#else
e443b333	85
5f36e231	86	static inline int ci_hdrc_gadget_init(struct ci13xxx *ci)
e443b333	87	{
5f36e231	88	return -ENXIO;
e443b333 AS	89	}
e443b333 AS	90
e443b333 AS	91	#endif
	92
	93	#endif /* __DRIVERS_USB_CHIPIDEA_UDC_H */