arch/arm/mach-msm/include/mach/usb_bam.h - kernel/msm - Gitiles

 /* Copyright (c) 2011-2013, The Linux Foundation. All rights reserved.
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License version 2 and
  * only version 2 as published by the Free Software Foundation.
  *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  */

 #ifndef _USB_BAM_H_
 #define _USB_BAM_H_
 #include "sps.h"
 #include <mach/ipa.h>
 #include <linux/usb/msm_hsusb.h>

 enum usb_bam {
 	SSUSB_BAM = 0,
 	HSUSB_BAM,
 	HSIC_BAM,
 	MAX_BAMS,
 };

 enum peer_bam {
 	A2_P_BAM = 0,
 	QDSS_P_BAM,
 	IPA_P_BAM,
 	MAX_PEER_BAMS,
 };

 enum usb_bam_pipe_dir {
 	USB_TO_PEER_PERIPHERAL,
 	PEER_PERIPHERAL_TO_USB,
 };

 enum usb_pipe_mem_type {
 	SPS_PIPE_MEM = 0,	/* Default, SPS dedicated pipe memory */
 	USB_PRIVATE_MEM,	/* USB's private memory */
 	SYSTEM_MEM,		/* System RAM, requires allocation */
 	OCI_MEM,		/* Shared memory among peripherals */
 };

 enum usb_bam_event_type {
 	USB_BAM_EVENT_WAKEUP_PIPE = 0,	/* Wake a pipe */
 	USB_BAM_EVENT_WAKEUP,		/* Wake a bam (first pipe waked) */
 	USB_BAM_EVENT_INACTIVITY,	/* Inactivity on all pipes */
 };

 struct usb_bam_connect_ipa_params {
 	u8 src_idx;
 	u8 dst_idx;
 	u32 *src_pipe;
 	u32 *dst_pipe;
 	enum usb_bam_pipe_dir dir;
 	/* client handle assigned by IPA to client */
 	u32 prod_clnt_hdl;
 	u32 cons_clnt_hdl;
 	/* params assigned by the CD */
 	enum ipa_client_type client;
 	struct ipa_ep_cfg ipa_ep_cfg;
 	void *priv;
 	void (*notify)(void *priv, enum ipa_dp_evt_type evt,
 			unsigned long data);
 	int (*activity_notify)(void *priv);
 	int (*inactivity_notify)(void *priv);
 };

 /**
 * struct usb_bam_event_info: suspend/resume event information.
 * @type: usb bam event type.
 * @event: holds event data.
 * @callback: suspend/resume callback.
 * @param: port num (for suspend) or NULL (for resume).
 * @event_w: holds work queue parameters.
 */
 struct usb_bam_event_info {
 	enum usb_bam_event_type type;
 	struct sps_register_event event;
 	int (*callback)(void *);
 	void *param;
 	struct work_struct event_w;
 };

 /**
 * struct usb_bam_pipe_connect: pipe connection information
 * between USB/HSIC BAM and another BAM. USB/HSIC BAM can be
 * either src BAM or dst BAM
 * @name: pipe description.
 * @mem_type: type of memory used for BAM FIFOs
 * @src_phy_addr: src bam physical address.
 * @src_pipe_index: src bam pipe index.
 * @dst_phy_addr: dst bam physical address.
 * @dst_pipe_index: dst bam pipe index.
 * @data_fifo_base_offset: data fifo offset.
 * @data_fifo_size: data fifo size.
 * @desc_fifo_base_offset: descriptor fifo offset.
 * @desc_fifo_size: descriptor fifo size.
 * @data_mem_buf: data fifo buffer.
 * @desc_mem_buf: descriptor fifo buffer.
 * @event: event for wakeup.
 * @enabled: true if pipe is enabled.
 * @priv: private data to return upon activity_notify
 *	or inactivity_notify callbacks.
 * @activity_notify: callback to invoke on activity on one of the in pipes.
 * @inactivity_notify: callback to invoke on inactivity on all pipes.
 */
 struct usb_bam_pipe_connect {
 	const char *name;
 	u32 pipe_num;
 	enum usb_pipe_mem_type mem_type;
 	enum usb_bam_pipe_dir dir;
 	enum usb_bam bam_type;
 	enum peer_bam peer_bam;
 	u32 src_phy_addr;
 	u32 src_pipe_index;
 	u32 dst_phy_addr;
 	u32 dst_pipe_index;
 	u32 data_fifo_base_offset;
 	u32 data_fifo_size;
 	u32 desc_fifo_base_offset;
 	u32 desc_fifo_size;
 	struct sps_mem_buffer data_mem_buf;
 	struct sps_mem_buffer desc_mem_buf;
 	struct usb_bam_event_info event;
 	bool enabled;
 	void *priv;
 	int (*activity_notify)(void *priv);
 	int (*inactivity_notify)(void *priv);
 };

 /**
  * struct msm_usb_bam_platform_data: pipe connection information
  * between USB/HSIC BAM and another BAM. USB/HSIC BAM can be
  * either src BAM or dst BAM
  * @connections: holds all pipe connections data.
  * @usb_bam_num_pipes: max number of pipes to use.
  * @active_conn_num: number of active pipe connections.
  * @usb_bam_fifo_baseaddr: base address for bam pipe's data and descriptor
  *                         fifos. This can be on chip memory (ocimem) or usb
  *                         private memory.
  * @ignore_core_reset_ack: BAM can ignore ACK from USB core during PIPE RESET
  * @disable_clk_gating: Disable clock gating
  */
 struct msm_usb_bam_platform_data {
 	struct usb_bam_pipe_connect *connections;
 	u8 max_connections;
 	int usb_bam_num_pipes;
 	phys_addr_t usb_bam_fifo_baseaddr;
 	bool ignore_core_reset_ack;
 	bool reset_on_connect[MAX_BAMS];
 	bool disable_clk_gating;
 };

 #ifdef CONFIG_USB_BAM
 /**
  * Connect USB-to-Peripheral SPS connection.
  *
  * This function returns the allocated pipe number.
  *
  * @idx - Connection index.
  *
  * @bam_pipe_idx - allocated pipe index.
  *
  * @return 0 on success, negative value on error
  *
  */
 int usb_bam_connect(u8 idx, u32 *bam_pipe_idx);

 /**
  * Connect USB-to-IPA SPS connection.
  *
  * This function returns the allocated pipes number and clnt
  * handles. Assumes that the user first connects producer pipes
  * and only after that consumer pipes, since that's the correct
  * sequence for the handshake with the IPA.
  *
  * @ipa_params - in/out parameters
  *
  * @return 0 on success, negative value on error
  *
  */
 int usb_bam_connect_ipa(struct usb_bam_connect_ipa_params *ipa_params);

 /**
  * Disconnect USB-to-IPA SPS connection.
  *
  * @ipa_params - in/out parameters
  *
  * @return 0 on success, negative value on error
  *
  */
 int usb_bam_disconnect_ipa(
 		struct usb_bam_connect_ipa_params *ipa_params);

 /**
  * Register a wakeup callback from peer BAM.
  *
  * @idx - Connection index.
  *
  * @callback - the callback function
  *
  * @return 0 on success, negative value on error
  *
  */
 int usb_bam_register_wake_cb(u8 idx,
 	int (*callback)(void *), void *param);

 /**
  * Register a callback for peer BAM reset.
  *
  * @callback - the callback function that will be called in USB
  *				driver upon a peer bam reset
  *
  * @param - context that the caller can supply
  *
  * @return 0 on success, negative value on error
  *
  */
 int usb_bam_register_peer_reset_cb(int (*callback)(void *), void *param);

 /**
  * Disconnect USB-to-Periperal SPS connection.
  *
  * @idx - Connection index.
  *
  * @return 0 on success, negative value on error
  */
 int usb_bam_disconnect_pipe(u8 idx);

 /**
  * Returns usb bam connection parameters.
  *
  * @idx - Connection index.
  *
  * @usb_bam_handle - Usb bam handle.
  *
  * @usb_bam_pipe_idx - Usb bam pipe index.
  *
  * @peer_pipe_idx - Peer pipe index.
  *
  * @desc_fifo - Descriptor fifo parameters.
  *
  * @data_fifo - Data fifo parameters.
  *
  * @return pipe index on success, negative value on error.
  */
 int get_bam2bam_connection_info(u8 idx,
 	u32 *usb_bam_handle, u32 *usb_bam_pipe_idx, u32 *peer_pipe_idx,
 	struct sps_mem_buffer *desc_fifo, struct sps_mem_buffer *data_fifo);

 /**
  * Resets the USB BAM that has A2 pipes
  *
  */
 int usb_bam_a2_reset(void);

 /**
  * Indicates if the client of the USB BAM is ready to start
  * sending/receiving transfers.
  *
  * @ready - TRUE to enable, FALSE to disable.
  *
  */
 int usb_bam_client_ready(bool ready);
 /**
 * Returns qdss index from the connections array.
 *
 * @num - The qdss pipe number.
 *
 * @return pipe index on success, negative value on error
 */
 int usb_bam_get_qdss_idx(u8 num);

 /**
 * Saves qdss core number.
 *
 * @qdss_core - The qdss core name.
 */
 void usb_bam_set_qdss_core(const char *qdss_core);

 /**
 * Indicates if the client of the USB BAM is ready to start
 * sending/receiving transfers.
 *
 * @name - Core name (ssusb/hsusb/hsic).
 *
 * @client - Usb pipe peer (a2, ipa, qdss...)
 *
 * @dir - In (from peer to usb) or out (from usb to peer)
 *
 * @num - Pipe number.
 *
 * @return 0 on success, negative value on error
 */
 int usb_bam_get_connection_idx(const char *name, enum peer_bam client,
 	enum usb_bam_pipe_dir dir, u32 num);

 #else
 static inline int usb_bam_connect(u8 idx, u32 *bam_pipe_idx)
 {
 	return -ENODEV;
 }

 static inline int usb_bam_connect_ipa(
 			struct usb_bam_connect_ipa_params *ipa_params)
 {
 	return -ENODEV;
 }

 static inline int usb_bam_disconnect_ipa(
 			struct usb_bam_connect_ipa_params *ipa_params)
 {
 	return -ENODEV;
 }

 static inline int usb_bam_register_wake_cb(u8 idx,
 	int (*callback)(void *), void* param)
 {
 	return -ENODEV;
 }

 static inline int usb_bam_register_peer_reset_cb(
 	int (*callback)(void *), void *param)
 {
 	return -ENODEV;
 }

 static inline int usb_bam_disconnect_pipe(u8 idx)
 {
 	return -ENODEV;
 }

 static inline int get_bam2bam_connection_info(u8 idx,
 	u32 *usb_bam_handle, u32 *usb_bam_pipe_idx, u32 *peer_pipe_idx,
 	struct sps_mem_buffer *desc_fifo, struct sps_mem_buffer *data_fifo)
 {
 	return -ENODEV;
 }

 static inline int usb_bam_a2_reset(void)
 {
 	return -ENODEV;
 }

 static inline int usb_bam_client_ready(bool ready)
 {
 	return -ENODEV;
 }

 static inline int usb_bam_get_qdss_idx(u8 num)
 {
 	return -ENODEV;
 }

 static inline void usb_bam_set_qdss_core(const char *qdss_core)
 {
 	return;
 }

 static inline int usb_bam_get_connection_idx(const char *name,
 		enum peer_bam client, enum usb_bam_pipe_dir dir, u32 num)
 {
 	return -ENODEV;
 }
 #endif
 #endif				/* _USB_BAM_H_ */
	/* Copyright (c) 2011-2013, The Linux Foundation. All rights reserved.
	*
	* This program is free software; you can redistribute it and/or modify
	* it under the terms of the GNU General Public License version 2 and
	* only version 2 as published by the Free Software Foundation.
	*
	* This program is distributed in the hope that it will be useful,
	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	* GNU General Public License for more details.
	*/

	#ifndef _USB_BAM_H_
	#define _USB_BAM_H_
	#include "sps.h"
	#include <mach/ipa.h>
	#include <linux/usb/msm_hsusb.h>

	enum usb_bam {
	SSUSB_BAM = 0,
	HSUSB_BAM,
	HSIC_BAM,
	MAX_BAMS,
	};

	enum peer_bam {
	A2_P_BAM = 0,
	QDSS_P_BAM,
	IPA_P_BAM,
	MAX_PEER_BAMS,
	};

	enum usb_bam_pipe_dir {
	USB_TO_PEER_PERIPHERAL,
	PEER_PERIPHERAL_TO_USB,
	};

	enum usb_pipe_mem_type {
	SPS_PIPE_MEM = 0, /* Default, SPS dedicated pipe memory */
	USB_PRIVATE_MEM, /* USB's private memory */
	SYSTEM_MEM, /* System RAM, requires allocation */
	OCI_MEM, /* Shared memory among peripherals */
	};

	enum usb_bam_event_type {
	USB_BAM_EVENT_WAKEUP_PIPE = 0, /* Wake a pipe */
	USB_BAM_EVENT_WAKEUP, /* Wake a bam (first pipe waked) */
	USB_BAM_EVENT_INACTIVITY, /* Inactivity on all pipes */
	};

	struct usb_bam_connect_ipa_params {
	u8 src_idx;
	u8 dst_idx;
	u32 *src_pipe;
	u32 *dst_pipe;
	enum usb_bam_pipe_dir dir;
	/* client handle assigned by IPA to client */
	u32 prod_clnt_hdl;
	u32 cons_clnt_hdl;
	/* params assigned by the CD */
	enum ipa_client_type client;
	struct ipa_ep_cfg ipa_ep_cfg;
	void *priv;
	void (notify)(void priv, enum ipa_dp_evt_type evt,
	unsigned long data);
	int (activity_notify)(void priv);
	int (inactivity_notify)(void priv);
	};

	/**
	* struct usb_bam_event_info: suspend/resume event information.
	* @type: usb bam event type.
	* @event: holds event data.
	* @callback: suspend/resume callback.
	* @param: port num (for suspend) or NULL (for resume).
	* @event_w: holds work queue parameters.
	*/
	struct usb_bam_event_info {
	enum usb_bam_event_type type;
	struct sps_register_event event;
	int (callback)(void );
	void *param;
	struct work_struct event_w;
	};

	/**
	* struct usb_bam_pipe_connect: pipe connection information
	* between USB/HSIC BAM and another BAM. USB/HSIC BAM can be
	* either src BAM or dst BAM
	* @name: pipe description.
	* @mem_type: type of memory used for BAM FIFOs
	* @src_phy_addr: src bam physical address.
	* @src_pipe_index: src bam pipe index.
	* @dst_phy_addr: dst bam physical address.
	* @dst_pipe_index: dst bam pipe index.
	* @data_fifo_base_offset: data fifo offset.
	* @data_fifo_size: data fifo size.
	* @desc_fifo_base_offset: descriptor fifo offset.
	* @desc_fifo_size: descriptor fifo size.
	* @data_mem_buf: data fifo buffer.
	* @desc_mem_buf: descriptor fifo buffer.
	* @event: event for wakeup.
	* @enabled: true if pipe is enabled.
	* @priv: private data to return upon activity_notify
	* or inactivity_notify callbacks.
	* @activity_notify: callback to invoke on activity on one of the in pipes.
	* @inactivity_notify: callback to invoke on inactivity on all pipes.
	*/
	struct usb_bam_pipe_connect {
	const char *name;
	u32 pipe_num;
	enum usb_pipe_mem_type mem_type;
	enum usb_bam_pipe_dir dir;
	enum usb_bam bam_type;
	enum peer_bam peer_bam;
	u32 src_phy_addr;
	u32 src_pipe_index;
	u32 dst_phy_addr;
	u32 dst_pipe_index;
	u32 data_fifo_base_offset;
	u32 data_fifo_size;
	u32 desc_fifo_base_offset;
	u32 desc_fifo_size;
	struct sps_mem_buffer data_mem_buf;
	struct sps_mem_buffer desc_mem_buf;
	struct usb_bam_event_info event;
	bool enabled;
	void *priv;
	int (activity_notify)(void priv);
	int (inactivity_notify)(void priv);
	};

	/**
	* struct msm_usb_bam_platform_data: pipe connection information
	* between USB/HSIC BAM and another BAM. USB/HSIC BAM can be
	* either src BAM or dst BAM
	* @connections: holds all pipe connections data.
	* @usb_bam_num_pipes: max number of pipes to use.
	* @active_conn_num: number of active pipe connections.
	* @usb_bam_fifo_baseaddr: base address for bam pipe's data and descriptor
	* fifos. This can be on chip memory (ocimem) or usb
	* private memory.
	* @ignore_core_reset_ack: BAM can ignore ACK from USB core during PIPE RESET
	* @disable_clk_gating: Disable clock gating
	*/
	struct msm_usb_bam_platform_data {
	struct usb_bam_pipe_connect *connections;
	u8 max_connections;
	int usb_bam_num_pipes;
	phys_addr_t usb_bam_fifo_baseaddr;
	bool ignore_core_reset_ack;
	bool reset_on_connect[MAX_BAMS];
	bool disable_clk_gating;
	};

	#ifdef CONFIG_USB_BAM
	/**
	* Connect USB-to-Peripheral SPS connection.
	*
	* This function returns the allocated pipe number.
	*
	* @idx - Connection index.
	*
	* @bam_pipe_idx - allocated pipe index.
	*
	* @return 0 on success, negative value on error
	*
	*/
	int usb_bam_connect(u8 idx, u32 *bam_pipe_idx);

	/**
	* Connect USB-to-IPA SPS connection.
	*
	* This function returns the allocated pipes number and clnt
	* handles. Assumes that the user first connects producer pipes
	* and only after that consumer pipes, since that's the correct
	* sequence for the handshake with the IPA.
	*
	* @ipa_params - in/out parameters
	*
	* @return 0 on success, negative value on error
	*
	*/
	int usb_bam_connect_ipa(struct usb_bam_connect_ipa_params *ipa_params);

	/**
	* Disconnect USB-to-IPA SPS connection.
	*
	* @ipa_params - in/out parameters
	*
	* @return 0 on success, negative value on error
	*
	*/
	int usb_bam_disconnect_ipa(
	struct usb_bam_connect_ipa_params *ipa_params);

	/**
	* Register a wakeup callback from peer BAM.
	*
	* @idx - Connection index.
	*
	* @callback - the callback function
	*
	* @return 0 on success, negative value on error
	*
	*/
	int usb_bam_register_wake_cb(u8 idx,
	int (callback)(void ), void *param);

	/**
	* Register a callback for peer BAM reset.
	*
	* @callback - the callback function that will be called in USB
	* driver upon a peer bam reset
	*
	* @param - context that the caller can supply
	*
	* @return 0 on success, negative value on error
	*
	*/
	int usb_bam_register_peer_reset_cb(int (callback)(void ), void *param);

	/**
	* Disconnect USB-to-Periperal SPS connection.
	*
	* @idx - Connection index.
	*
	* @return 0 on success, negative value on error
	*/
	int usb_bam_disconnect_pipe(u8 idx);

	/**
	* Returns usb bam connection parameters.
	*
	* @idx - Connection index.
	*
	* @usb_bam_handle - Usb bam handle.
	*
	* @usb_bam_pipe_idx - Usb bam pipe index.
	*
	* @peer_pipe_idx - Peer pipe index.
	*
	* @desc_fifo - Descriptor fifo parameters.
	*
	* @data_fifo - Data fifo parameters.
	*
	* @return pipe index on success, negative value on error.
	*/
	int get_bam2bam_connection_info(u8 idx,
	u32 usb_bam_handle, u32 usb_bam_pipe_idx, u32 *peer_pipe_idx,
	struct sps_mem_buffer desc_fifo, struct sps_mem_buffer data_fifo);

	/**
	* Resets the USB BAM that has A2 pipes
	*
	*/
	int usb_bam_a2_reset(void);

	/**
	* Indicates if the client of the USB BAM is ready to start
	* sending/receiving transfers.
	*
	* @ready - TRUE to enable, FALSE to disable.
	*
	*/
	int usb_bam_client_ready(bool ready);
	/**
	* Returns qdss index from the connections array.
	*
	* @num - The qdss pipe number.
	*
	* @return pipe index on success, negative value on error
	*/
	int usb_bam_get_qdss_idx(u8 num);

	/**
	* Saves qdss core number.
	*
	* @qdss_core - The qdss core name.
	*/
	void usb_bam_set_qdss_core(const char *qdss_core);

	/**
	* Indicates if the client of the USB BAM is ready to start
	* sending/receiving transfers.
	*
	* @name - Core name (ssusb/hsusb/hsic).
	*
	* @client - Usb pipe peer (a2, ipa, qdss...)
	*
	* @dir - In (from peer to usb) or out (from usb to peer)
	*
	* @num - Pipe number.
	*
	* @return 0 on success, negative value on error
	*/
	int usb_bam_get_connection_idx(const char *name, enum peer_bam client,
	enum usb_bam_pipe_dir dir, u32 num);

	#else
	static inline int usb_bam_connect(u8 idx, u32 *bam_pipe_idx)
	{
	return -ENODEV;
	}

	static inline int usb_bam_connect_ipa(
	struct usb_bam_connect_ipa_params *ipa_params)
	{
	return -ENODEV;
	}

	static inline int usb_bam_disconnect_ipa(
	struct usb_bam_connect_ipa_params *ipa_params)
	{
	return -ENODEV;
	}

	static inline int usb_bam_register_wake_cb(u8 idx,
	int (callback)(void ), void* param)
	{
	return -ENODEV;
	}

	static inline int usb_bam_register_peer_reset_cb(
	int (callback)(void ), void *param)
	{
	return -ENODEV;
	}

	static inline int usb_bam_disconnect_pipe(u8 idx)
	{
	return -ENODEV;
	}

	static inline int get_bam2bam_connection_info(u8 idx,
	u32 usb_bam_handle, u32 usb_bam_pipe_idx, u32 *peer_pipe_idx,
	struct sps_mem_buffer desc_fifo, struct sps_mem_buffer data_fifo)
	{
	return -ENODEV;
	}

	static inline int usb_bam_a2_reset(void)
	{
	return -ENODEV;
	}

	static inline int usb_bam_client_ready(bool ready)
	{
	return -ENODEV;
	}

	static inline int usb_bam_get_qdss_idx(u8 num)
	{
	return -ENODEV;
	}

	static inline void usb_bam_set_qdss_core(const char *qdss_core)
	{
	return;
	}

	static inline int usb_bam_get_connection_idx(const char *name,
	enum peer_bam client, enum usb_bam_pipe_dir dir, u32 num)
	{
	return -ENODEV;
	}
	#endif
	#endif /* _USB_BAM_H_ */