libgphoto2 photo camera library (libgphoto2) API 2.5.24

gphoto2-port.h
Go to the documentation of this file.
1
24 #ifndef __GPHOTO2_PORT_H__
25 #define __GPHOTO2_PORT_H__
26
27 #include <gphoto2/gphoto2-port-info-list.h>
28
29 /* For portability */
30 #include <gphoto2/gphoto2-port-portability.h>
31 #ifdef OS2
32 #include <gphoto2/gphoto2-port-portability-os2.h>
33 #include <os2.h>
34 #endif
35
36 #ifdef __cplusplus
37 extern "C" {
38 #endif /* __cplusplus */
39
40 #ifndef TRUE
41 #define TRUE (0==0)
42 #endif
43
44 #ifndef FALSE
45 #define FALSE (1==0)
46 #endif
47
53 typedef enum _GPPortSerialParity
54 {
55 GP_PORT_SERIAL_PARITY_OFF = 0,
56 GP_PORT_SERIAL_PARITY_EVEN,
57 GP_PORT_SERIAL_PARITY_ODD
58 } GPPortSerialParity;
59
61 #define GP_PORT_MAX_BUF_LEN 4096
62
66 typedef struct _GPPortSettingsSerial {
67 char port[128];
68 int speed;
69 int bits;
70 GPPortSerialParity parity;
72 int stopbits;
73 } GPPortSettingsSerial;
74
78 typedef struct _GPPortSettingsUSB {
79 int inep;
80 int outep;
81 int intep;
82 int config;
83 int interface;
84 int altsetting;
86 int maxpacketsize;
88 /* must be last to avoid binary incompatibility.
89 * luckily we just need to make sure this struct does not
90 * get larger than _GPPortSettingsSerial. */
91 char port[64];
92 } GPPortSettingsUSB;
93
97 typedef struct _GPPortSettingsUsbDiskDirect {
98 char path[128];
99 } GPPortSettingsUsbDiskDirect;
100
104 typedef struct _GPPortSettingsUsbScsi {
105 char path[128];
106 } GPPortSettingsUsbScsi;
107
114 typedef union _GPPortSettings {
115 GPPortSettingsSerial serial;
116 GPPortSettingsUSB usb;
117 GPPortSettingsUsbDiskDirect usbdiskdirect;
118 GPPortSettingsUsbScsi usbscsi;
119 } GPPortSettings;
120
121 enum {
122 GP_PORT_USB_ENDPOINT_IN,
123 GP_PORT_USB_ENDPOINT_OUT,
124 GP_PORT_USB_ENDPOINT_INT
125 };
126
127 typedef struct _GPPortPrivateLibrary GPPortPrivateLibrary;
128 typedef struct _GPPortPrivateCore GPPortPrivateCore;
129
143 typedef struct _GPPort {
144 /* For your convenience */
145 GPPortType type;
147 GPPortSettings settings;
148 GPPortSettings settings_pending;
150 int timeout;
152 GPPortPrivateLibrary *pl;
153 GPPortPrivateCore *pc;
154 } GPPort;
155
156 int gp_port_new (GPPort **port);
157 int gp_port_free (GPPort *port);
158
159 int gp_port_set_info (GPPort *port, GPPortInfo info);
160 int gp_port_get_info (GPPort *port, GPPortInfo *info);
161
162 int gp_port_open (GPPort *port);
163 int gp_port_close (GPPort *port);
164
165 int gp_port_reset (GPPort *port);
166
167 int gp_port_write (GPPort *port, const char *data, int size);
168 int gp_port_read (GPPort *port, char *data, int size);
169 int gp_port_check_int (GPPort *port, char *data, int size);
170 int gp_port_check_int_fast (GPPort *port, char *data, int size);
171
172 int gp_port_get_timeout (GPPort *port, int *timeout);
173 int gp_port_set_timeout (GPPort *port, int timeout);
174
175 int gp_port_set_settings (GPPort *port, GPPortSettings settings);
176 int gp_port_get_settings (GPPort *port, GPPortSettings *settings);
177
184 typedef enum _GPPin {
185 GP_PIN_RTS,
186 GP_PIN_DTR,
187 GP_PIN_CTS,
188 GP_PIN_DSR,
189 GP_PIN_CD,
190 GP_PIN_RING
191 } GPPin;
192
198 typedef enum _GPLevel {
199 GP_LEVEL_LOW = 0,
200 GP_LEVEL_HIGH = 1
201 } GPLevel;
202
203 int gp_port_get_pin (GPPort *port, GPPin pin, GPLevel *level);
204 int gp_port_set_pin (GPPort *port, GPPin pin, GPLevel level);
205
206 int gp_port_send_break (GPPort *port, int duration);
207 int gp_port_flush (GPPort *port, int direction);
208
209 int gp_port_usb_find_device (GPPort *port, int idvendor, int idproduct);
210 int gp_port_usb_find_device_by_class (GPPort *port, int mainclass, int subclass, int protocol);
211 int gp_port_usb_clear_halt (GPPort *port, int ep);
212 int gp_port_usb_msg_write (GPPort *port, int request, int value,
213 int index, char *bytes, int size);
214 int gp_port_usb_msg_read (GPPort *port, int request, int value,
215 int index, char *bytes, int size);
216 int gp_port_usb_msg_interface_write (GPPort *port, int request,
217 int value, int index, char *bytes, int size);
218 int gp_port_usb_msg_interface_read (GPPort *port, int request,
219 int value, int index, char *bytes, int size);
220 int gp_port_usb_msg_class_write (GPPort *port, int request,
221 int value, int index, char *bytes, int size);
222 int gp_port_usb_msg_class_read (GPPort *port, int request,
223 int value, int index, char *bytes, int size);
224
225 int gp_port_seek (GPPort *port, int offset, int whence);
226
227 int gp_port_send_scsi_cmd (GPPort *port, int to_dev,
228 char *cmd, int cmd_size,
229 char *sense, int sense_size,
230 char *data, int data_size);
231
232 /* Error reporting */
233 int gp_port_set_error (GPPort *port, const char *format, ...)
234 #ifdef __GNUC__
235 __attribute__((__format__(printf,2,3)))
236 #endif
237 ;
238 const char *gp_port_get_error (GPPort *port);
239
240 /* DEPRECATED */
242 typedef GPPort gp_port;
244 typedef GPPortSettings gp_port_settings;
246 #define PIN_CTS GP_PIN_CTS
247
248 #ifdef __cplusplus
249 }
250 #endif /* __cplusplus */
251
252 #endif /* __GPHOTO2_PORT_H__ */
GPPortSettings
union _GPPortSettings GPPortSettings
Union of port settings.
_GPPortInfo
Definition: gphoto2-port-info.h:32
GPPortSettingsUsbScsi
struct _GPPortSettingsUsbScsi GPPortSettingsUsbScsi
Port settings for USB Mass Storage raw SCSI ports.
gp_port_usb_msg_read
int gp_port_usb_msg_read(GPPort *port, int request, int value, int index, char *bytes, int size)
Send a USB control message with input data.
Definition: gphoto2-port.c:897
_GPPortSettingsSerial::parity
GPPortSerialParity parity
Definition: gphoto2-port.h:70
gp_port_get_info
int gp_port_get_info(GPPort *port, GPPortInfo *info)
Retreives information about the port.
Definition: gphoto2-port.c:255
GPPort
struct _GPPort GPPort
The GPhoto port structure.
gp_port_usb_msg_interface_write
int gp_port_usb_msg_interface_write(GPPort *port, int request, int value, int index, char *bytes, int size)
Send a USB interface control message with output data.
Definition: gphoto2-port.c:937
gp_port_settings
GPPortSettings gp_port_settings
Definition: gphoto2-port.h:244
gp_port_get_settings
int gp_port_get_settings(GPPort *port, GPPortSettings *settings)
Get the current port settings.
Definition: gphoto2-port.c:632
_GPPortSettingsUsbScsi::path
char path[128]
Definition: gphoto2-port.h:105
gp_port
GPPort gp_port
Definition: gphoto2-port.h:242
gp_port_get_pin
int gp_port_get_pin(GPPort *port, GPPin pin, GPLevel *level)
Get setting of specific serial PIN.
Definition: gphoto2-port.c:651
GP_PIN_DTR
@ GP_PIN_DTR
DTR line.
Definition: gphoto2-port.h:186
_GPPortSettingsUsbScsi
Port settings for USB Mass Storage raw SCSI ports.
Definition: gphoto2-port.h:104
GP_PORT_USB_ENDPOINT_OUT
@ GP_PORT_USB_ENDPOINT_OUT
USB bulk OUT ep.
Definition: gphoto2-port.h:123
gp_port_new
int gp_port_new(GPPort **port)
Create new GPPort.
Definition: gphoto2-port.c:94
gp_port_flush
int gp_port_flush(GPPort *port, int direction)
Flush data on serial port.
Definition: gphoto2-port.c:762
gp_port_set_info
int gp_port_set_info(GPPort *port, GPPortInfo info)
Configure a port.
Definition: gphoto2-port.c:149
gp_port_set_settings
int gp_port_set_settings(GPPort *port, GPPortSettings settings)
Set port settings.
Definition: gphoto2-port.c:590
GP_PORT_USB_ENDPOINT_INT
@ GP_PORT_USB_ENDPOINT_INT
USB Interrupt ep.
Definition: gphoto2-port.h:124
_GPPortSettings::usbdiskdirect
GPPortSettingsUsbDiskDirect usbdiskdirect
usb disk direct port specific settings
Definition: gphoto2-port.h:117
_GPPort::pc
GPPortPrivateCore * pc
Port library private data pointer.
Definition: gphoto2-port.h:153
GPPortSerialParity
enum _GPPortSerialParity GPPortSerialParity
Serial parity.
_GPPortSettingsUSB::intep
int intep
Interrupt endpoint used.
Definition: gphoto2-port.h:81
gp_port_check_int
int gp_port_check_int(GPPort *port, char *data, int size)
Check for intterupt.
Definition: gphoto2-port.c:463
GPPortSettingsUsbDiskDirect
struct _GPPortSettingsUsbDiskDirect GPPortSettingsUsbDiskDirect
Port settings for USB mass storage direct IO ports.
GP_PIN_DSR
@ GP_PIN_DSR
DSR line.
Definition: gphoto2-port.h:188
_GPPortSettingsUSB
Port settings for USB ports.
Definition: gphoto2-port.h:78
gp_port_set_pin
int gp_port_set_pin(GPPort *port, GPPin pin, GPLevel level)
Set specified serial PIN to value.
Definition: gphoto2-port.c:703
gp_port_usb_find_device
int gp_port_usb_find_device(GPPort *port, int idvendor, int idproduct)
Find USB device by vendor/product.
Definition: gphoto2-port.c:790
GP_PIN_CTS
@ GP_PIN_CTS
CTS line.
Definition: gphoto2-port.h:187
gp_port_open
int gp_port_open(GPPort *port)
Open a port.
Definition: gphoto2-port.c:273
_GPPortSettingsUSB::maxpacketsize
int maxpacketsize
Maximum USB packetsize of the IN endpoint. (r/o)
Definition: gphoto2-port.h:86
GP_PIN_RING
@ GP_PIN_RING
RING (Modem) line.
Definition: gphoto2-port.h:190
_GPPortSettingsUSB::config
int config
USB bConfigurationValue used.
Definition: gphoto2-port.h:82
gp_port_free
int gp_port_free(GPPort *port)
Free the port structure.
Definition: gphoto2-port.c:341
gp_port_read
int gp_port_read(GPPort *port, char *data, int size)
Read data from port.
Definition: gphoto2-port.c:427
_GPPort
The GPhoto port structure.
Definition: gphoto2-port.h:143
gp_port_usb_msg_write
int gp_port_usb_msg_write(GPPort *port, int request, int value, int index, char *bytes, int size)
Send a USB control message with output data.
Definition: gphoto2-port.c:864
gp_port_set_timeout
int gp_port_set_timeout(GPPort *port, int timeout)
Set timeout of port.
Definition: gphoto2-port.c:534
_GPPort::settings_pending
GPPortSettings settings_pending
Settings to be committed.
Definition: gphoto2-port.h:148
_GPPortSettings::serial
GPPortSettingsSerial serial
Serial specific settings.
Definition: gphoto2-port.h:115
GP_PIN_CD
@ GP_PIN_CD
Carrier Detect line.
Definition: gphoto2-port.h:189
_GPPortSettings::usb
GPPortSettingsUSB usb
USB specific settings.
Definition: gphoto2-port.h:116
_GPPortPrivateCore
Internal private libgphoto2_port data. This structure contains private data.
Definition: gphoto2-port.c:73
_GPPortSettingsUSB::inep
int inep
Bulk IN endpoint used.
Definition: gphoto2-port.h:79
GP_PIN_RTS
@ GP_PIN_RTS
RTS line.
Definition: gphoto2-port.h:185
gp_port_get_error
const char * gp_port_get_error(GPPort *port)
Get verbose port error message.
Definition: gphoto2-port.c:1210
gp_port_reset
int gp_port_reset(GPPort *port)
Reset a port.
Definition: gphoto2-port.c:319
gp_port_close
int gp_port_close(GPPort *port)
Close a port.
Definition: gphoto2-port.c:297
GPPortSettingsUSB
struct _GPPortSettingsUSB GPPortSettingsUSB
Port settings for USB ports.
_GPPortSettingsUsbDiskDirect
Port settings for USB mass storage direct IO ports.
Definition: gphoto2-port.h:97
GP_PORT_SERIAL_PARITY_ODD
@ GP_PORT_SERIAL_PARITY_ODD
Parity is odd.
Definition: gphoto2-port.h:57
gp_port_send_scsi_cmd
int gp_port_send_scsi_cmd(GPPort *port, int to_dev, char *cmd, int cmd_size, char *sense, int sense_size, char *data, int data_size)
Send a SCSI command to a port (for usb scsi ports)
Definition: gphoto2-port.c:1118
gp_port_usb_msg_class_write
int gp_port_usb_msg_class_write(GPPort *port, int request, int value, int index, char *bytes, int size)
Send a USB class control message with output data.
Definition: gphoto2-port.c:1015
_GPPin
_GPPin
Serial pins.
Definition: gphoto2-port.h:184
_GPPortSerialParity
_GPPortSerialParity
Serial parity.
Definition: gphoto2-port.h:53
gp_port_usb_clear_halt
int gp_port_usb_clear_halt(GPPort *port, int ep)
Clear USB endpoint HALT condition.
Definition: gphoto2-port.c:836
GPLevel
enum _GPLevel GPLevel
Level to pull specific lines.
gp_port_send_break
int gp_port_send_break(GPPort *port, int duration)
Send a break over a serial port.
Definition: gphoto2-port.c:737
_GPPortSettingsUSB::outep
int outep
Bulk OUT endpoint used.
Definition: gphoto2-port.h:80
GPPin
enum _GPPin GPPin
Serial pins.
_GPLevel
_GPLevel
Level to pull specific lines.
Definition: gphoto2-port.h:198
gp_port_seek
int gp_port_seek(GPPort *port, int offset, int whence)
Seek on a port (for usb disk direct ports)
Definition: gphoto2-port.c:1084
_GPPortSettingsUSB::port
char port[64]
USB Portname. Specific to lowlevel USB.
Definition: gphoto2-port.h:91
gp_port_usb_msg_class_read
int gp_port_usb_msg_class_read(GPPort *port, int request, int value, int index, char *bytes, int size)
Send a USB class control message with input data.
Definition: gphoto2-port.c:1050
_GPPortSettings
Union of port settings.
Definition: gphoto2-port.h:114
GP_LEVEL_HIGH
@ GP_LEVEL_HIGH
Pull to high (nV)
Definition: gphoto2-port.h:200
_GPPortSettings::usbscsi
GPPortSettingsUsbScsi usbscsi
usb scsi port specific settings
Definition: gphoto2-port.h:118
gp_port_usb_msg_interface_read
int gp_port_usb_msg_interface_read(GPPort *port, int request, int value, int index, char *bytes, int size)
Send a USB interface control message with input data.
Definition: gphoto2-port.c:972
gphoto2-port-info-list.h
GP_PORT_SERIAL_PARITY_EVEN
@ GP_PORT_SERIAL_PARITY_EVEN
Parity is even.
Definition: gphoto2-port.h:56
GP_LEVEL_LOW
@ GP_LEVEL_LOW
Pull to low (0V)
Definition: gphoto2-port.h:199
gp_port_set_error
int gp_port_set_error(GPPort *port, const char *format,...)
Set verbose port error message.
Definition: gphoto2-port.c:1180
_GPPort::pl
GPPortPrivateLibrary * pl
Camera driver private data pointer.
Definition: gphoto2-port.h:152
_GPPortSettingsUsbDiskDirect::path
char path[128]
Definition: gphoto2-port.h:98
gp_port_usb_find_device_by_class
int gp_port_usb_find_device_by_class(GPPort *port, int mainclass, int subclass, int protocol)
Find USB device by interface class.
Definition: gphoto2-port.c:814
_GPPortSettingsSerial
Port settings for serial ports.
Definition: gphoto2-port.h:66
_GPPortSettingsUSB::altsetting
int altsetting
USB Alternative Setting used.
Definition: gphoto2-port.h:84
_GPPortSettingsSerial::bits
int bits
Definition: gphoto2-port.h:69
GP_PORT_USB_ENDPOINT_IN
@ GP_PORT_USB_ENDPOINT_IN
USB bulk IN ep.
Definition: gphoto2-port.h:122
_GPPort::timeout
int timeout
Port timeout in milliseconds.
Definition: gphoto2-port.h:150
gp_port_check_int_fast
int gp_port_check_int_fast(GPPort *port, char *data, int size)
Check for interrupt without wait.
Definition: gphoto2-port.c:496
_GPPort::settings
GPPortSettings settings
Current port settings.
Definition: gphoto2-port.h:147
gp_port_write
int gp_port_write(GPPort *port, const char *data, int size)
Writes a specified amount of data to a port.
Definition: gphoto2-port.c:392
GPPortSettingsSerial
struct _GPPortSettingsSerial GPPortSettingsSerial
Port settings for serial ports.
_GPPortSettingsSerial::port
char port[128]
Definition: gphoto2-port.h:67
_GPPort::type
GPPortType type
Actual type of this port.
Definition: gphoto2-port.h:145
_GPPortSettingsSerial::stopbits
int stopbits
Definition: gphoto2-port.h:72
_GPPortSettingsUSB::interface
int interface
USB Interface number used.
Definition: gphoto2-port.h:83
gp_port_get_timeout
int gp_port_get_timeout(GPPort *port, int *timeout)
Get the current port timeout.
Definition: gphoto2-port.c:568
GP_PORT_SERIAL_PARITY_OFF
@ GP_PORT_SERIAL_PARITY_OFF
Parity is off (disabled)
Definition: gphoto2-port.h:55
_GPPortSettingsSerial::speed
int speed
Definition: gphoto2-port.h:68
GPPortType
GPPortType
The gphoto port type.
Definition: gphoto2-port-info-list.h:34