[GitHub/mt8127/android_kernel_alcatel_ttab.git] / include / linux / rio_drv.h

/*
 * RapidIO driver services
 *
 * Copyright 2005 MontaVista Software, Inc.
 * Matt Porter <mporter@kernel.crashing.org>
 *
 * This program is free software; you can redistribute  it and/or modify it
 * under  the terms of  the GNU General  Public License as published by the
 * Free Software Foundation;  either version 2 of the  License, or (at your
 * option) any later version.
 */

#ifndef LINUX_RIO_DRV_H
#define LINUX_RIO_DRV_H

#include <linux/types.h>
#include <linux/ioport.h>
#include <linux/list.h>
#include <linux/errno.h>
#include <linux/string.h>
#include <linux/rio.h>

extern int __rio_local_read_config_32(struct rio_mport *port, u32 offset,
				      u32 * data);
extern int __rio_local_write_config_32(struct rio_mport *port, u32 offset,
				       u32 data);
extern int __rio_local_read_config_16(struct rio_mport *port, u32 offset,
				      u16 * data);
extern int __rio_local_write_config_16(struct rio_mport *port, u32 offset,
				       u16 data);
extern int __rio_local_read_config_8(struct rio_mport *port, u32 offset,
				     u8 * data);
extern int __rio_local_write_config_8(struct rio_mport *port, u32 offset,
				      u8 data);

extern int rio_mport_read_config_32(struct rio_mport *port, u16 destid,
				    u8 hopcount, u32 offset, u32 * data);
extern int rio_mport_write_config_32(struct rio_mport *port, u16 destid,
				     u8 hopcount, u32 offset, u32 data);
extern int rio_mport_read_config_16(struct rio_mport *port, u16 destid,
				    u8 hopcount, u32 offset, u16 * data);
extern int rio_mport_write_config_16(struct rio_mport *port, u16 destid,
				     u8 hopcount, u32 offset, u16 data);
extern int rio_mport_read_config_8(struct rio_mport *port, u16 destid,
				   u8 hopcount, u32 offset, u8 * data);
extern int rio_mport_write_config_8(struct rio_mport *port, u16 destid,
				    u8 hopcount, u32 offset, u8 data);

/**
 * rio_local_read_config_32 - Read 32 bits from local configuration space
 * @port: Master port
 * @offset: Offset into local configuration space
 * @data: Pointer to read data into
 *
 * Reads 32 bits of data from the specified offset within the local
 * device's configuration space.
 */
static inline int rio_local_read_config_32(struct rio_mport *port, u32 offset,
					   u32 * data)
{
	return __rio_local_read_config_32(port, offset, data);
}

/**
 * rio_local_write_config_32 - Write 32 bits to local configuration space
 * @port: Master port
 * @offset: Offset into local configuration space
 * @data: Data to be written
 *
 * Writes 32 bits of data to the specified offset within the local
 * device's configuration space.
 */
static inline int rio_local_write_config_32(struct rio_mport *port, u32 offset,
					    u32 data)
{
	return __rio_local_write_config_32(port, offset, data);
}

/**
 * rio_local_read_config_16 - Read 16 bits from local configuration space
 * @port: Master port
 * @offset: Offset into local configuration space
 * @data: Pointer to read data into
 *
 * Reads 16 bits of data from the specified offset within the local
 * device's configuration space.
 */
static inline int rio_local_read_config_16(struct rio_mport *port, u32 offset,
					   u16 * data)
{
	return __rio_local_read_config_16(port, offset, data);
}

/**
 * rio_local_write_config_16 - Write 16 bits to local configuration space
 * @port: Master port
 * @offset: Offset into local configuration space
 * @data: Data to be written
 *
 * Writes 16 bits of data to the specified offset within the local
 * device's configuration space.
 */

static inline int rio_local_write_config_16(struct rio_mport *port, u32 offset,
					    u16 data)
{
	return __rio_local_write_config_16(port, offset, data);
}

/**
 * rio_local_read_config_8 - Read 8 bits from local configuration space
 * @port: Master port
 * @offset: Offset into local configuration space
 * @data: Pointer to read data into
 *
 * Reads 8 bits of data from the specified offset within the local
 * device's configuration space.
 */
static inline int rio_local_read_config_8(struct rio_mport *port, u32 offset,
					  u8 * data)
{
	return __rio_local_read_config_8(port, offset, data);
}

/**
 * rio_local_write_config_8 - Write 8 bits to local configuration space
 * @port: Master port
 * @offset: Offset into local configuration space
 * @data: Data to be written
 *
 * Writes 8 bits of data to the specified offset within the local
 * device's configuration space.
 */
static inline int rio_local_write_config_8(struct rio_mport *port, u32 offset,
					   u8 data)
{
	return __rio_local_write_config_8(port, offset, data);
}

/**
 * rio_read_config_32 - Read 32 bits from configuration space
 * @rdev: RIO device
 * @offset: Offset into device configuration space
 * @data: Pointer to read data into
 *
 * Reads 32 bits of data from the specified offset within the
 * RIO device's configuration space.
 */
static inline int rio_read_config_32(struct rio_dev *rdev, u32 offset,
				     u32 * data)
{
	return rio_mport_read_config_32(rdev->net->hport, rdev->destid,
					rdev->hopcount, offset, data);
};

/**
 * rio_write_config_32 - Write 32 bits to configuration space
 * @rdev: RIO device
 * @offset: Offset into device configuration space
 * @data: Data to be written
 *
 * Writes 32 bits of data to the specified offset within the
 * RIO device's configuration space.
 */
static inline int rio_write_config_32(struct rio_dev *rdev, u32 offset,
				      u32 data)
{
	return rio_mport_write_config_32(rdev->net->hport, rdev->destid,
					 rdev->hopcount, offset, data);
};

/**
 * rio_read_config_16 - Read 16 bits from configuration space
 * @rdev: RIO device
 * @offset: Offset into device configuration space
 * @data: Pointer to read data into
 *
 * Reads 16 bits of data from the specified offset within the
 * RIO device's configuration space.
 */
static inline int rio_read_config_16(struct rio_dev *rdev, u32 offset,
				     u16 * data)
{
	return rio_mport_read_config_16(rdev->net->hport, rdev->destid,
					rdev->hopcount, offset, data);
};

/**
 * rio_write_config_16 - Write 16 bits to configuration space
 * @rdev: RIO device
 * @offset: Offset into device configuration space
 * @data: Data to be written
 *
 * Writes 16 bits of data to the specified offset within the
 * RIO device's configuration space.
 */
static inline int rio_write_config_16(struct rio_dev *rdev, u32 offset,
				      u16 data)
{
	return rio_mport_write_config_16(rdev->net->hport, rdev->destid,
					 rdev->hopcount, offset, data);
};

/**
 * rio_read_config_8 - Read 8 bits from configuration space
 * @rdev: RIO device
 * @offset: Offset into device configuration space
 * @data: Pointer to read data into
 *
 * Reads 8 bits of data from the specified offset within the
 * RIO device's configuration space.
 */
static inline int rio_read_config_8(struct rio_dev *rdev, u32 offset, u8 * data)
{
	return rio_mport_read_config_8(rdev->net->hport, rdev->destid,
				       rdev->hopcount, offset, data);
};

/**
 * rio_write_config_8 - Write 8 bits to configuration space
 * @rdev: RIO device
 * @offset: Offset into device configuration space
 * @data: Data to be written
 *
 * Writes 8 bits of data to the specified offset within the
 * RIO device's configuration space.
 */
static inline int rio_write_config_8(struct rio_dev *rdev, u32 offset, u8 data)
{
	return rio_mport_write_config_8(rdev->net->hport, rdev->destid,
					rdev->hopcount, offset, data);
};

extern int rio_mport_send_doorbell(struct rio_mport *mport, u16 destid,
				   u16 data);

/**
 * rio_send_doorbell - Send a doorbell message to a device
 * @rdev: RIO device
 * @data: Doorbell message data
 *
 * Send a doorbell message to a RIO device. The doorbell message
 * has a 16-bit info field provided by the @data argument.
 */
static inline int rio_send_doorbell(struct rio_dev *rdev, u16 data)
{
	return rio_mport_send_doorbell(rdev->net->hport, rdev->destid, data);
};

/**
 * rio_init_mbox_res - Initialize a RIO mailbox resource
 * @res: resource struct
 * @start: start of mailbox range
 * @end: end of mailbox range
 *
 * This function is used to initialize the fields of a resource
 * for use as a mailbox resource.  It initializes a range of
 * mailboxes using the start and end arguments.
 */
static inline void rio_init_mbox_res(struct resource *res, int start, int end)
{
	memset(res, 0, sizeof(struct resource));
	res->start = start;
	res->end = end;
	res->flags = RIO_RESOURCE_MAILBOX;
}

/**
 * rio_init_dbell_res - Initialize a RIO doorbell resource
 * @res: resource struct
 * @start: start of doorbell range
 * @end: end of doorbell range
 *
 * This function is used to initialize the fields of a resource
 * for use as a doorbell resource.  It initializes a range of
 * doorbell messages using the start and end arguments.
 */
static inline void rio_init_dbell_res(struct resource *res, u16 start, u16 end)
{
	memset(res, 0, sizeof(struct resource));
	res->start = start;
	res->end = end;
	res->flags = RIO_RESOURCE_DOORBELL;
}

/**
 * RIO_DEVICE - macro used to describe a specific RIO device
 * @dev: the 16 bit RIO device ID
 * @ven: the 16 bit RIO vendor ID
 *
 * This macro is used to create a struct rio_device_id that matches a
 * specific device.  The assembly vendor and assembly device fields
 * will be set to %RIO_ANY_ID.
 */
#define RIO_DEVICE(dev,ven) \
	.did = (dev), .vid = (ven), \
	.asm_did = RIO_ANY_ID, .asm_vid = RIO_ANY_ID

/* Mailbox management */
extern int rio_request_outb_mbox(struct rio_mport *, void *, int, int,
				 void (*)(struct rio_mport *, void *,int, int));
extern int rio_release_outb_mbox(struct rio_mport *, int);

/**
 * rio_add_outb_message - Add RIO message to an outbound mailbox queue
 * @mport: RIO master port containing the outbound queue
 * @rdev: RIO device the message is be sent to
 * @mbox: The outbound mailbox queue
 * @buffer: Pointer to the message buffer
 * @len: Length of the message buffer
 *
 * Adds a RIO message buffer to an outbound mailbox queue for
 * transmission. Returns 0 on success.
 */
static inline int rio_add_outb_message(struct rio_mport *mport,
				       struct rio_dev *rdev, int mbox,
				       void *buffer, size_t len)
{
	return mport->ops->add_outb_message(mport, rdev, mbox,
						   buffer, len);
}

extern int rio_request_inb_mbox(struct rio_mport *, void *, int, int,
				void (*)(struct rio_mport *, void *, int, int));
extern int rio_release_inb_mbox(struct rio_mport *, int);

/**
 * rio_add_inb_buffer - Add buffer to an inbound mailbox queue
 * @mport: Master port containing the inbound mailbox
 * @mbox: The inbound mailbox number
 * @buffer: Pointer to the message buffer
 *
 * Adds a buffer to an inbound mailbox queue for reception. Returns
 * 0 on success.
 */
static inline int rio_add_inb_buffer(struct rio_mport *mport, int mbox,
				     void *buffer)
{
	return mport->ops->add_inb_buffer(mport, mbox, buffer);
}

/**
 * rio_get_inb_message - Get A RIO message from an inbound mailbox queue
 * @mport: Master port containing the inbound mailbox
 * @mbox: The inbound mailbox number
 *
 * Get a RIO message from an inbound mailbox queue. Returns 0 on success.
 */
static inline void *rio_get_inb_message(struct rio_mport *mport, int mbox)
{
	return mport->ops->get_inb_message(mport, mbox);
}

/* Doorbell management */
extern int rio_request_inb_dbell(struct rio_mport *, void *, u16, u16,
				 void (*)(struct rio_mport *, void *, u16, u16, u16));
extern int rio_release_inb_dbell(struct rio_mport *, u16, u16);
extern struct resource *rio_request_outb_dbell(struct rio_dev *, u16, u16);
extern int rio_release_outb_dbell(struct rio_dev *, struct resource *);

/* Memory region management */
int rio_claim_resource(struct rio_dev *, int);
int rio_request_regions(struct rio_dev *, char *);
void rio_release_regions(struct rio_dev *);
int rio_request_region(struct rio_dev *, int, char *);
void rio_release_region(struct rio_dev *, int);

/* Memory mapping functions */
extern int rio_map_inb_region(struct rio_mport *mport, dma_addr_t local,
			u64 rbase, u32 size, u32 rflags);
extern void rio_unmap_inb_region(struct rio_mport *mport, dma_addr_t lstart);

/* Port-Write management */
extern int rio_request_inb_pwrite(struct rio_dev *,
			int (*)(struct rio_dev *, union rio_pw_msg*, int));
extern int rio_release_inb_pwrite(struct rio_dev *);
extern int rio_inb_pwrite_handler(union rio_pw_msg *pw_msg);

/* LDM support */
int rio_register_driver(struct rio_driver *);
void rio_unregister_driver(struct rio_driver *);
struct rio_dev *rio_dev_get(struct rio_dev *);
void rio_dev_put(struct rio_dev *);

#ifdef CONFIG_RAPIDIO_DMA_ENGINE
extern struct dma_chan *rio_request_dma(struct rio_dev *rdev);
extern void rio_release_dma(struct dma_chan *dchan);
extern struct dma_async_tx_descriptor *rio_dma_prep_slave_sg(
		struct rio_dev *rdev, struct dma_chan *dchan,
		struct rio_dma_data *data,
		enum dma_transfer_direction direction, unsigned long flags);
#endif

/**
 * rio_name - Get the unique RIO device identifier
 * @rdev: RIO device
 *
 * Get the unique RIO device identifier. Returns the device
 * identifier string.
 */
static inline const char *rio_name(struct rio_dev *rdev)
{
	return dev_name(&rdev->dev);
}

/**
 * rio_get_drvdata - Get RIO driver specific data
 * @rdev: RIO device
 *
 * Get RIO driver specific data. Returns a pointer to the
 * driver specific data.
 */
static inline void *rio_get_drvdata(struct rio_dev *rdev)
{
	return dev_get_drvdata(&rdev->dev);
}

/**
 * rio_set_drvdata - Set RIO driver specific data
 * @rdev: RIO device
 * @data: Pointer to driver specific data
 *
 * Set RIO driver specific data. device struct driver data pointer
 * is set to the @data argument.
 */
static inline void rio_set_drvdata(struct rio_dev *rdev, void *data)
{
	dev_set_drvdata(&rdev->dev, data);
}

/* Misc driver helpers */
extern u16 rio_local_get_device_id(struct rio_mport *port);
extern struct rio_dev *rio_get_device(u16 vid, u16 did, struct rio_dev *from);
extern struct rio_dev *rio_get_asm(u16 vid, u16 did, u16 asm_vid, u16 asm_did,
				   struct rio_dev *from);
extern int rio_init_mports(void);

#endif				/* LINUX_RIO_DRV_H */
Commit	Line	Data
70a50ebd MP	1	/*
	2	* RapidIO driver services
	3	*
	4	* Copyright 2005 MontaVista Software, Inc.
	5	* Matt Porter <mporter@kernel.crashing.org>
	6	*
	7	* This program is free software; you can redistribute it and/or modify it
	8	* under the terms of the GNU General Public License as published by the
	9	* Free Software Foundation; either version 2 of the License, or (at your
	10	* option) any later version.
	11	*/
	12
	13	#ifndef LINUX_RIO_DRV_H
	14	#define LINUX_RIO_DRV_H
	15
70a50ebd	16	#include <linux/types.h>
70a50ebd MP	17	#include <linux/ioport.h>
	18	#include <linux/list.h>
	19	#include <linux/errno.h>
de25968c	20	#include <linux/string.h>
70a50ebd MP	21	#include <linux/rio.h>
	22
	23	extern int __rio_local_read_config_32(struct rio_mport *port, u32 offset,
	24	u32 * data);
	25	extern int __rio_local_write_config_32(struct rio_mport *port, u32 offset,
	26	u32 data);
	27	extern int __rio_local_read_config_16(struct rio_mport *port, u32 offset,
	28	u16 * data);
	29	extern int __rio_local_write_config_16(struct rio_mport *port, u32 offset,
	30	u16 data);
	31	extern int __rio_local_read_config_8(struct rio_mport *port, u32 offset,
	32	u8 * data);
	33	extern int __rio_local_write_config_8(struct rio_mport *port, u32 offset,
	34	u8 data);
	35
	36	extern int rio_mport_read_config_32(struct rio_mport *port, u16 destid,
	37	u8 hopcount, u32 offset, u32 * data);
	38	extern int rio_mport_write_config_32(struct rio_mport *port, u16 destid,
	39	u8 hopcount, u32 offset, u32 data);
	40	extern int rio_mport_read_config_16(struct rio_mport *port, u16 destid,
	41	u8 hopcount, u32 offset, u16 * data);
	42	extern int rio_mport_write_config_16(struct rio_mport *port, u16 destid,
	43	u8 hopcount, u32 offset, u16 data);
	44	extern int rio_mport_read_config_8(struct rio_mport *port, u16 destid,
	45	u8 hopcount, u32 offset, u8 * data);
	46	extern int rio_mport_write_config_8(struct rio_mport *port, u16 destid,
	47	u8 hopcount, u32 offset, u8 data);
	48
	49	/**
	50	* rio_local_read_config_32 - Read 32 bits from local configuration space
	51	* @port: Master port
	52	* @offset: Offset into local configuration space
	53	* @data: Pointer to read data into
	54	*
	55	* Reads 32 bits of data from the specified offset within the local
	56	* device's configuration space.
	57	*/
	58	static inline int rio_local_read_config_32(struct rio_mport *port, u32 offset,
	59	u32 * data)
	60	{
	61	return __rio_local_read_config_32(port, offset, data);
	62	}
	63
	64	/**
	65	* rio_local_write_config_32 - Write 32 bits to local configuration space
	66	* @port: Master port
	67	* @offset: Offset into local configuration space
	68	* @data: Data to be written
	69	*
	70	* Writes 32 bits of data to the specified offset within the local
	71	* device's configuration space.
	72	*/
	73	static inline int rio_local_write_config_32(struct rio_mport *port, u32 offset,
	74	u32 data)
	75	{
	76	return __rio_local_write_config_32(port, offset, data);
	77	}
	78
	79	/**
	80	* rio_local_read_config_16 - Read 16 bits from local configuration space
	81	* @port: Master port
	82	* @offset: Offset into local configuration space
	83	* @data: Pointer to read data into
	84	*
85	* Reads 16 bits of data from the specified offset within the local
86	* device's configuration space.
87	*/
88	static inline int rio_local_read_config_16(struct rio_mport *port, u32 offset,
89	u16 * data)
90	{
91	return __rio_local_read_config_16(port, offset, data);
92	}
93
94	/**
95	* rio_local_write_config_16 - Write 16 bits to local configuration space
96	* @port: Master port
97	* @offset: Offset into local configuration space
98	* @data: Data to be written
99	*
100	* Writes 16 bits of data to the specified offset within the local
101	* device's configuration space.
102	*/
103
104	static inline int rio_local_write_config_16(struct rio_mport *port, u32 offset,
105	u16 data)
106	{
107	return __rio_local_write_config_16(port, offset, data);
108	}
109
110	/**
111	* rio_local_read_config_8 - Read 8 bits from local configuration space
112	* @port: Master port
113	* @offset: Offset into local configuration space
114	* @data: Pointer to read data into
115	*
116	* Reads 8 bits of data from the specified offset within the local
117	* device's configuration space.
118	*/
119	static inline int rio_local_read_config_8(struct rio_mport *port, u32 offset,
120	u8 * data)
121	{
122	return __rio_local_read_config_8(port, offset, data);
123	}
124
125	/**
126	* rio_local_write_config_8 - Write 8 bits to local configuration space
127	* @port: Master port
128	* @offset: Offset into local configuration space
129	* @data: Data to be written
130	*
131	* Writes 8 bits of data to the specified offset within the local
132	* device's configuration space.
133	*/
134	static inline int rio_local_write_config_8(struct rio_mport *port, u32 offset,
135	u8 data)
136	{
137	return __rio_local_write_config_8(port, offset, data);
138	}
139
140	/**
141	* rio_read_config_32 - Read 32 bits from configuration space
142	* @rdev: RIO device
143	* @offset: Offset into device configuration space
144	* @data: Pointer to read data into
145	*
146	* Reads 32 bits of data from the specified offset within the
147	* RIO device's configuration space.
148	*/
149	static inline int rio_read_config_32(struct rio_dev *rdev, u32 offset,
150	u32 * data)
151	{
a93192a5 AB	152	return rio_mport_read_config_32(rdev->net->hport, rdev->destid,
a93192a5 AB	153	rdev->hopcount, offset, data);
70a50ebd MP	154	};
	155
	156	/**
	157	* rio_write_config_32 - Write 32 bits to configuration space
	158	* @rdev: RIO device
	159	* @offset: Offset into device configuration space
	160	* @data: Data to be written
	161	*
	162	* Writes 32 bits of data to the specified offset within the
	163	* RIO device's configuration space.
	164	*/
	165	static inline int rio_write_config_32(struct rio_dev *rdev, u32 offset,
	166	u32 data)
	167	{
a93192a5 AB	168	return rio_mport_write_config_32(rdev->net->hport, rdev->destid,
a93192a5 AB	169	rdev->hopcount, offset, data);
70a50ebd MP	170	};
	171
	172	/**
	173	* rio_read_config_16 - Read 16 bits from configuration space
	174	* @rdev: RIO device
	175	* @offset: Offset into device configuration space
	176	* @data: Pointer to read data into
	177	*
	178	* Reads 16 bits of data from the specified offset within the
	179	* RIO device's configuration space.
	180	*/
	181	static inline int rio_read_config_16(struct rio_dev *rdev, u32 offset,
	182	u16 * data)
	183	{
a93192a5 AB	184	return rio_mport_read_config_16(rdev->net->hport, rdev->destid,
a93192a5 AB	185	rdev->hopcount, offset, data);
70a50ebd MP	186	};
	187
	188	/**
	189	* rio_write_config_16 - Write 16 bits to configuration space
	190	* @rdev: RIO device
	191	* @offset: Offset into device configuration space
	192	* @data: Data to be written
	193	*
	194	* Writes 16 bits of data to the specified offset within the
	195	* RIO device's configuration space.
	196	*/
	197	static inline int rio_write_config_16(struct rio_dev *rdev, u32 offset,
	198	u16 data)
	199	{
a93192a5 AB	200	return rio_mport_write_config_16(rdev->net->hport, rdev->destid,
a93192a5 AB	201	rdev->hopcount, offset, data);
70a50ebd MP	202	};
	203
	204	/**
	205	* rio_read_config_8 - Read 8 bits from configuration space
	206	* @rdev: RIO device
	207	* @offset: Offset into device configuration space
	208	* @data: Pointer to read data into
	209	*
	210	* Reads 8 bits of data from the specified offset within the
	211	* RIO device's configuration space.
	212	*/
	213	static inline int rio_read_config_8(struct rio_dev rdev, u32 offset, u8 data)
	214	{
a93192a5 AB	215	return rio_mport_read_config_8(rdev->net->hport, rdev->destid,
a93192a5 AB	216	rdev->hopcount, offset, data);
70a50ebd MP	217	};
	218
	219	/**
	220	* rio_write_config_8 - Write 8 bits to configuration space
	221	* @rdev: RIO device
	222	* @offset: Offset into device configuration space
	223	* @data: Data to be written
	224	*
	225	* Writes 8 bits of data to the specified offset within the
	226	* RIO device's configuration space.
	227	*/
	228	static inline int rio_write_config_8(struct rio_dev *rdev, u32 offset, u8 data)
	229	{
a93192a5 AB	230	return rio_mport_write_config_8(rdev->net->hport, rdev->destid,
a93192a5 AB	231	rdev->hopcount, offset, data);
70a50ebd MP	232	};
	233
	234	extern int rio_mport_send_doorbell(struct rio_mport *mport, u16 destid,
	235	u16 data);
	236
	237	/**
	238	* rio_send_doorbell - Send a doorbell message to a device
	239	* @rdev: RIO device
	240	* @data: Doorbell message data
	241	*
	242	* Send a doorbell message to a RIO device. The doorbell message
	243	* has a 16-bit info field provided by the @data argument.
	244	*/
	245	static inline int rio_send_doorbell(struct rio_dev *rdev, u16 data)
	246	{
	247	return rio_mport_send_doorbell(rdev->net->hport, rdev->destid, data);
	248	};
	249
	250	/**
	251	* rio_init_mbox_res - Initialize a RIO mailbox resource
	252	* @res: resource struct
	253	* @start: start of mailbox range
	254	* @end: end of mailbox range
	255	*
	256	* This function is used to initialize the fields of a resource
	257	* for use as a mailbox resource. It initializes a range of
	258	* mailboxes using the start and end arguments.
	259	*/
	260	static inline void rio_init_mbox_res(struct resource *res, int start, int end)
	261	{
	262	memset(res, 0, sizeof(struct resource));
	263	res->start = start;
	264	res->end = end;
	265	res->flags = RIO_RESOURCE_MAILBOX;
	266	}
	267
	268	/**
	269	* rio_init_dbell_res - Initialize a RIO doorbell resource
	270	* @res: resource struct
	271	* @start: start of doorbell range
	272	* @end: end of doorbell range
	273	*
	274	* This function is used to initialize the fields of a resource
	275	* for use as a doorbell resource. It initializes a range of
	276	* doorbell messages using the start and end arguments.
	277	*/
	278	static inline void rio_init_dbell_res(struct resource *res, u16 start, u16 end)
	279	{
	280	memset(res, 0, sizeof(struct resource));
	281	res->start = start;
	282	res->end = end;
	283	res->flags = RIO_RESOURCE_DOORBELL;
	284	}
	285
	286	/**
	287	* RIO_DEVICE - macro used to describe a specific RIO device
0863afb3 MW	288	* @dev: the 16 bit RIO device ID
0863afb3 MW	289	* @ven: the 16 bit RIO vendor ID
70a50ebd MP	290	*
	291	* This macro is used to create a struct rio_device_id that matches a
	292	* specific device. The assembly vendor and assembly device fields
	293	* will be set to %RIO_ANY_ID.
	294	*/
	295	#define RIO_DEVICE(dev,ven) \
	296	.did = (dev), .vid = (ven), \
	297	.asm_did = RIO_ANY_ID, .asm_vid = RIO_ANY_ID
	298
	299	/* Mailbox management */
6978bbc0 MP	300	extern int rio_request_outb_mbox(struct rio_mport , void , int, int,
6978bbc0 MP	301	void ()(struct rio_mport , void *,int, int));
70a50ebd MP	302	extern int rio_release_outb_mbox(struct rio_mport *, int);
	303
	304	/**
	305	* rio_add_outb_message - Add RIO message to an outbound mailbox queue
	306	* @mport: RIO master port containing the outbound queue
	307	* @rdev: RIO device the message is be sent to
	308	* @mbox: The outbound mailbox queue
	309	* @buffer: Pointer to the message buffer
	310	* @len: Length of the message buffer
	311	*
	312	* Adds a RIO message buffer to an outbound mailbox queue for
	313	* transmission. Returns 0 on success.
	314	*/
	315	static inline int rio_add_outb_message(struct rio_mport *mport,
	316	struct rio_dev *rdev, int mbox,
	317	void *buffer, size_t len)
	318	{
f8f06269 AB	319	return mport->ops->add_outb_message(mport, rdev, mbox,
f8f06269 AB	320	buffer, len);
70a50ebd MP	321	}
70a50ebd MP	322
6978bbc0 MP	323	extern int rio_request_inb_mbox(struct rio_mport , void , int, int,
6978bbc0 MP	324	void ()(struct rio_mport , void *, int, int));
70a50ebd MP	325	extern int rio_release_inb_mbox(struct rio_mport *, int);
	326
	327	/**
	328	* rio_add_inb_buffer - Add buffer to an inbound mailbox queue
	329	* @mport: Master port containing the inbound mailbox
	330	* @mbox: The inbound mailbox number
	331	* @buffer: Pointer to the message buffer
	332	*
	333	* Adds a buffer to an inbound mailbox queue for reception. Returns
	334	* 0 on success.
	335	*/
	336	static inline int rio_add_inb_buffer(struct rio_mport *mport, int mbox,
	337	void *buffer)
	338	{
f8f06269	339	return mport->ops->add_inb_buffer(mport, mbox, buffer);
70a50ebd MP	340	}
	341
	342	/**
	343	* rio_get_inb_message - Get A RIO message from an inbound mailbox queue
	344	* @mport: Master port containing the inbound mailbox
	345	* @mbox: The inbound mailbox number
70a50ebd MP	346	*
	347	* Get a RIO message from an inbound mailbox queue. Returns 0 on success.
	348	*/
	349	static inline void rio_get_inb_message(struct rio_mport mport, int mbox)
	350	{
f8f06269	351	return mport->ops->get_inb_message(mport, mbox);
70a50ebd MP	352	}
	353
	354	/* Doorbell management */
6978bbc0 MP	355	extern int rio_request_inb_dbell(struct rio_mport , void , u16, u16,
6978bbc0 MP	356	void ()(struct rio_mport , void *, u16, u16, u16));
70a50ebd MP	357	extern int rio_release_inb_dbell(struct rio_mport *, u16, u16);
	358	extern struct resource rio_request_outb_dbell(struct rio_dev , u16, u16);
	359	extern int rio_release_outb_dbell(struct rio_dev , struct resource );
	360
	361	/* Memory region management */
	362	int rio_claim_resource(struct rio_dev *, int);
	363	int rio_request_regions(struct rio_dev , char );
	364	void rio_release_regions(struct rio_dev *);
	365	int rio_request_region(struct rio_dev , int, char );
	366	void rio_release_region(struct rio_dev *, int);
	367
da1589f0 AB	368	/* Memory mapping functions */
	369	extern int rio_map_inb_region(struct rio_mport *mport, dma_addr_t local,
	370	u64 rbase, u32 size, u32 rflags);
	371	extern void rio_unmap_inb_region(struct rio_mport *mport, dma_addr_t lstart);
	372
e5cabeb3 AB	373	/* Port-Write management */
	374	extern int rio_request_inb_pwrite(struct rio_dev *,
	375	int ()(struct rio_dev , union rio_pw_msg*, int));
	376	extern int rio_release_inb_pwrite(struct rio_dev *);
	377	extern int rio_inb_pwrite_handler(union rio_pw_msg *pw_msg);
	378
70a50ebd MP	379	/* LDM support */
	380	int rio_register_driver(struct rio_driver *);
	381	void rio_unregister_driver(struct rio_driver *);
	382	struct rio_dev rio_dev_get(struct rio_dev );
	383	void rio_dev_put(struct rio_dev *);
	384
e42d98eb AB	385	#ifdef CONFIG_RAPIDIO_DMA_ENGINE
	386	extern struct dma_chan rio_request_dma(struct rio_dev rdev);
	387	extern void rio_release_dma(struct dma_chan *dchan);
	388	extern struct dma_async_tx_descriptor *rio_dma_prep_slave_sg(
	389	struct rio_dev rdev, struct dma_chan dchan,
	390	struct rio_dma_data *data,
	391	enum dma_transfer_direction direction, unsigned long flags);
	392	#endif
	393
70a50ebd MP	394	/**
	395	* rio_name - Get the unique RIO device identifier
	396	* @rdev: RIO device
	397	*
	398	* Get the unique RIO device identifier. Returns the device
	399	* identifier string.
	400	*/
b53c7583	401	static inline const char rio_name(struct rio_dev rdev)
70a50ebd	402	{
b53c7583	403	return dev_name(&rdev->dev);
70a50ebd MP	404	}
	405
	406	/**
	407	* rio_get_drvdata - Get RIO driver specific data
	408	* @rdev: RIO device
	409	*
	410	* Get RIO driver specific data. Returns a pointer to the
	411	* driver specific data.
	412	*/
	413	static inline void rio_get_drvdata(struct rio_dev rdev)
	414	{
	415	return dev_get_drvdata(&rdev->dev);
	416	}
	417
	418	/**
	419	* rio_set_drvdata - Set RIO driver specific data
	420	* @rdev: RIO device
	421	* @data: Pointer to driver specific data
	422	*
	423	* Set RIO driver specific data. device struct driver data pointer
	424	* is set to the @data argument.
	425	*/
	426	static inline void rio_set_drvdata(struct rio_dev rdev, void data)
	427	{
	428	dev_set_drvdata(&rdev->dev, data);
	429	}
	430
	431	/* Misc driver helpers */
	432	extern u16 rio_local_get_device_id(struct rio_mport *port);
	433	extern struct rio_dev rio_get_device(u16 vid, u16 did, struct rio_dev from);
	434	extern struct rio_dev *rio_get_asm(u16 vid, u16 did, u16 asm_vid, u16 asm_did,
	435	struct rio_dev *from);
a11650e1	436	extern int rio_init_mports(void);
70a50ebd	437
70a50ebd	438	#endif /* LINUX_RIO_DRV_H */