summaryrefslogtreecommitdiff
path: root/usrp/host/lib/fusb_darwin.h
blob: 735e5f16d0548540252f9c7248eea1b1ca0cc8b7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
/* -*- c++ -*- */
/*
 * Copyright 2006,2009 Free Software Foundation, Inc.
 * 
 * This file is part of GNU Radio.
 *
 * GNU Radio 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 3, or (at your option)
 * any later version.
 * 
 * GNU Radio 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.
 * 
 * You should have received a copy of the GNU General Public License
 * along with GNU Radio; see the file COPYING.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street,
 * Boston, MA 02110-1301, USA.
 */

#ifndef _FUSB_DARWIN_H_
#define _FUSB_DARWIN_H_

#include <usb.h>
#include "fusb.h"
#include <IOKit/IOCFBundle.h>
#include <IOKit/IOCFPlugIn.h>
#include <IOKit/usb/IOUSBLib.h>
#include <IOKit/IOKitLib.h>
#include "circular_linked_list.h"
#include "circular_buffer.h"

// for MacOS X 10.4.[0-3]
#define usb_interface_t IOUSBInterfaceInterface220
#define InterfaceInterfaceID kIOUSBInterfaceInterfaceID220
#define InterfaceVersion 220

// for MacOS X 10.3.[0-9] and 10.4.[0-3]
#define usb_device_t    IOUSBDeviceInterface197
#define DeviceInterfaceID kIOUSBDeviceInterfaceID197
#define DeviceVersion 197

extern "C" {
typedef struct usb_dev_handle {
  int fd;

  struct usb_bus *bus;
  struct usb_device *device;

  int config;
  int interface;
  int altsetting;

  /* Added by RMT so implementations can store other per-open-device data */
  void *impl_info;
} usb_dev_handle;

/* Darwin/OS X impl does not use fd field, instead it uses this */
typedef struct darwin_dev_handle {
  usb_device_t** device;
  usb_interface_t** interface;
  int open;
} darwin_dev_handle;

typedef IOReturn io_return_t;
typedef IOCFPlugInInterface *io_cf_plugin_ref_t;

static int ep_to_pipeRef (darwin_dev_handle* device, int ep);
extern int usb_debug;
}

class s_buffer
{
private:
  char* d_buffer;
  size_t d_n_used, d_n_alloc;

public:
  inline s_buffer (size_t n_alloc = 0) {
    d_n_used = 0;
    d_n_alloc = n_alloc;
    if (n_alloc) {
      d_buffer = (char*) new char [n_alloc];
    } else {
      d_buffer = 0;
    }
  };
  inline ~s_buffer () {
    if (d_n_alloc) {
      delete [] d_buffer;
    }
  };
  inline size_t n_used () { return (d_n_used); };
  inline void n_used (size_t bufLen) {
    d_n_used = (bufLen > d_n_alloc) ? d_n_alloc : bufLen; };
  inline size_t n_alloc () { return (d_n_alloc); };
  void buffer (char* l_buffer, size_t bufLen) {
    if (bufLen > d_n_alloc) {
      std::cerr << "s_buffer::set: Copying only allocated bytes." << std::endl;
      bufLen = d_n_alloc;
    }
    if (!l_buffer) {
      std::cerr << "s_buffer::set: NULL buffer." << std::endl;
      return;
    }
    bcopy (l_buffer, d_buffer, bufLen);
    d_n_used = bufLen;
  };
  inline char* buffer () { return (d_buffer); };
  inline void reset () {
    bzero (d_buffer, d_n_alloc);
    d_n_used = 0;
  };
};

typedef s_buffer* s_buffer_ptr;
typedef s_node<s_buffer_ptr>* s_node_ptr;
typedef circular_linked_list<s_buffer_ptr>* s_queue_ptr;
typedef s_both<s_buffer_ptr>* s_both_ptr;

/*!
 * \brief darwin implementation of fusb_devhandle
 *
 * This is currently identical to the generic implementation
 * and is intended as a starting point for whatever magic is
 * required to make usb fly.
 */
class fusb_devhandle_darwin : public fusb_devhandle
{
public:
  // CREATORS
  fusb_devhandle_darwin (usb_dev_handle* udh);
  virtual ~fusb_devhandle_darwin ();

  // MANIPULATORS
  virtual fusb_ephandle* make_ephandle (int endpoint, bool input_p,
					int block_size = 0, int nblocks = 0);
};

/*!
 * \brief 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.
 */
class fusb_ephandle_darwin : public fusb_ephandle
{
private:
  fusb_devhandle_darwin* d_devhandle;
  mld_thread_ptr d_runThread;
  mld_mutex_ptr d_runThreadRunning;

  CFRunLoopRef d_CFRunLoopRef;

  static void write_completed (void* ret_io_size,
			       io_return_t result,
			       void* io_size);
  static void read_completed (void* ret_io_size,
			      io_return_t result,
			      void* io_size);
  static void run_thread (void* arg);
  static void read_thread (void* arg);

  void read_issue (s_both_ptr l_both);

public:
  // variables, for now
  UInt8 d_pipeRef, 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;
  mld_mutex_ptr d_readRunning;
  mld_condition_ptr d_runBlock, d_readBlock;

// CREATORS

  fusb_ephandle_darwin (fusb_devhandle_darwin *dh, int endpoint, bool input_p,
			 int block_size = 0, int nblocks = 0);
  virtual ~fusb_ephandle_darwin ();

// MANIPULATORS

  virtual bool start ();  	//!< begin streaming i/o
  virtual bool stop ();		//!< stop streaming i/o

  /*!
   * \returns \p nbytes if write was successfully enqueued, else -1.
   * Will block if no free buffers available.
   */
  virtual int write (const void* buffer, int nbytes);

  /*!
   * \returns number of bytes read or -1 if error.
   * number of bytes read will be <= nbytes.
   * Will block if no input available.
   */
  virtual int read (void* buffer, int nbytes);

  /*
   * abort any pending IO transfers
   */
  void abort ();

  /*
   * block until all outstanding writes have completed
   */
  virtual void wait_for_completion ();
};

#endif /* _FUSB_DARWIN_H_ */