fusb_ephandle_darwin Class Reference

darwin implementation of fusb_ephandle More...

#include <fusb_darwin.h>

Inheritance diagram for fusb_ephandle_darwin:

Collaboration diagram for fusb_ephandle_darwin:

List of all members.

Public Member Functions
	fusb_ephandle_darwin (fusb_devhandle_darwin *dh, int endpoint, bool input_p, int block_size=0, int nblocks=0)
virtual	~fusb_ephandle_darwin ()
virtual bool	start ()
	begin streaming i/o
virtual bool	stop ()
	stop streaming i/o
virtual int	write (const void *buffer, int nbytes)
virtual int	read (void *buffer, int nbytes)
void	abort ()
virtual void	wait_for_completion ()
Public Attributes
UInt8	d_pipeRef
UInt8	d_transferType
usb_interface_t **	d_interfaceRef
usb_interface_t *	d_interface
s_queue_ptr	d_queue
circular_buffer< char > *	d_buffer
size_t	d_bufLenBytes
gruel::mutex *	d_readRunning
gruel::mutex *	d_runBlock_mutex
gruel::mutex *	d_readBlock_mutex
gruel::condition_variable *	d_runBlock
gruel::condition_variable *	d_readBlock

---

Detailed Description

darwin implementation of fusb_ephandle

This is currently identical to the generic implementation and is intended as a starting point for whatever magic is required to make usb fly.

---

Constructor & Destructor Documentation

fusb_ephandle_darwin::fusb_ephandle_darwin	(	fusb_devhandle_darwin *	dh,
		int	endpoint,
		bool	input_p,
		int	block_size = 0,
		int	nblocks = 0
	)

References d_bufLenBytes, fusb_sysconfig::max_block_size(), d_buffer, fusb_ephandle::d_input_p, d_queue, s_node::both(), s_node::object(), d_readRunning, d_runBlock, d_readBlock, d_runBlock_mutex, and d_readBlock_mutex.

fusb_ephandle_darwin::~fusb_ephandle_darwin

(

)

[virtual]

References stop(), d_queue, circular_linked_list::iterate_start(), circular_linked_list::iterate_next(), s_node::both(), s_node::object(), d_buffer, d_readRunning, d_runBlock_mutex, d_readBlock_mutex, d_runBlock, and d_readBlock.

---

Member Function Documentation

void fusb_ephandle_darwin::abort

(

)

References usb_debug, d_interface, d_interfaceRef, d_pipeRef, and USB_ERROR_STR_NO_RET.

Referenced by stop().

int fusb_ephandle_darwin::read	(	void *	buffer,
		int	nbytes
	)		[virtual]

Returns:

number of bytes read or -1 if error. number of bytes read will be <= nbytes. Will block if no input available.

Implements fusb_ephandle.

References d_buffer, circular_buffer::dequeue(), and usb_debug.

bool fusb_ephandle_darwin::start

(

)

[virtual]

begin streaming i/o

Implements fusb_ephandle.

References d_buffer, circular_buffer::reset(), d_queue, circular_linked_list::num_used(), circular_linked_list::iterate_start(), circular_linked_list::iterate_next(), s_node::both(), s_both::set(), s_node::object(), s_node::set_available(), d_pipeRef, d_transferType, fusb_devhandle::get_usb_dev_handle(), USB_ERROR_STR, usb_dev_handle::impl_info, usb_debug, d_interfaceRef, darwin_dev_handle::interface, d_interface, fusb_ephandle::d_endpoint, fusb_ephandle::d_input_p, fusb_ephandle::d_started, d_runBlock_mutex, and d_runBlock.

bool fusb_ephandle_darwin::stop

(

)

[virtual]

stop streaming i/o

Implements fusb_ephandle.

References fusb_ephandle::d_started, usb_debug, fusb_ephandle::d_input_p, abort(), wait_for_completion(), d_buffer, and circular_buffer::abort().

Referenced by ~fusb_ephandle_darwin().

void fusb_ephandle_darwin::wait_for_completion

(

)

[virtual]

Implements fusb_ephandle.

References d_queue, and circular_linked_list::in_use().

Referenced by stop().

int fusb_ephandle_darwin::write	(	const void *	buffer,
		int	nbytes
	)		[virtual]

Returns:

nbytes if write was successfully enqueued, else -1. Will block if no free buffers available.

Implements fusb_ephandle.

References fusb_ephandle::d_started, usb_debug, d_bufLenBytes, d_queue, circular_linked_list::find_next_available_node(), s_node::object(), s_buffer::buffer(), s_node::both(), d_transferType, d_interface, d_interfaceRef, d_pipeRef, and USB_ERROR_STR.

---

Member Data Documentation

circular_buffer<char>* fusb_ephandle_darwin::d_buffer

Referenced by fusb_ephandle_darwin(), ~fusb_ephandle_darwin(), start(), read(), and stop().

size_t fusb_ephandle_darwin::d_bufLenBytes

Referenced by fusb_ephandle_darwin(), and write().

usb_interface_t* fusb_ephandle_darwin::d_interface

Referenced by start(), write(), and abort().

usb_interface_t** fusb_ephandle_darwin::d_interfaceRef

Referenced by start(), write(), and abort().

UInt8 fusb_ephandle_darwin::d_pipeRef

Referenced by start(), write(), and abort().

s_queue_ptr fusb_ephandle_darwin::d_queue

Referenced by fusb_ephandle_darwin(), ~fusb_ephandle_darwin(), start(), write(), and wait_for_completion().

gruel::condition_variable* fusb_ephandle_darwin::d_readBlock

Referenced by fusb_ephandle_darwin(), and ~fusb_ephandle_darwin().

gruel::mutex* fusb_ephandle_darwin::d_readBlock_mutex

Referenced by fusb_ephandle_darwin(), and ~fusb_ephandle_darwin().

gruel::mutex* fusb_ephandle_darwin::d_readRunning

Referenced by fusb_ephandle_darwin(), and ~fusb_ephandle_darwin().

gruel::condition_variable* fusb_ephandle_darwin::d_runBlock

Referenced by fusb_ephandle_darwin(), ~fusb_ephandle_darwin(), and start().

gruel::mutex* fusb_ephandle_darwin::d_runBlock_mutex

Referenced by fusb_ephandle_darwin(), ~fusb_ephandle_darwin(), and start().

UInt8 fusb_ephandle_darwin::d_transferType

Referenced by start(), and write().

---

The documentation for this class was generated from the following files:

• fusb_darwin.h
• fusb_darwin.cc