libgphoto2 photo camera library (libgphoto2) API  2.5.28
gphoto2-port.h
Go to the documentation of this file.
1 
24 #ifndef LIBGPHOTO2_GPHOTO2_PORT_H
25 #define LIBGPHOTO2_GPHOTO2_PORT_H
26 
28 
29 /* For portability */
30 #include <gphoto2/gphoto2-port-portability.h>
31 
32 #ifdef __cplusplus
33 extern "C" {
34 #endif /* __cplusplus */
35 
36 #ifndef TRUE
37 #define TRUE (0==0)
38 #endif
39 
40 #ifndef FALSE
41 #define FALSE (1==0)
42 #endif
43 
49 typedef enum _GPPortSerialParity
50 {
55 
57 #define GP_PORT_MAX_BUF_LEN 4096
58 
62 typedef struct _GPPortSettingsSerial {
63  char port[128];
64  int speed;
65  int bits;
68  int stopbits;
70 
74 typedef struct _GPPortSettingsUSB {
75  int inep;
76  int outep;
77  int intep;
78  int config;
79  int interface;
80  int altsetting;
84  /* must be last to avoid binary incompatibility.
85  * luckily we just need to make sure this struct does not
86  * get larger than _GPPortSettingsSerial. */
87  char port[64];
89 
94  char path[128];
96 
100 typedef struct _GPPortSettingsUsbScsi {
101  char path[128];
103 
110 typedef union _GPPortSettings {
116 
117 enum {
121 };
122 
123 typedef struct _GPPortPrivateLibrary GPPortPrivateLibrary;
125 
139 typedef struct _GPPort {
140  /* For your convenience */
146  int timeout;
148  GPPortPrivateLibrary *pl;
151 
152 int gp_port_new (GPPort **port);
153 int gp_port_free (GPPort *port);
154 
155 int gp_port_set_info (GPPort *port, GPPortInfo info);
156 int gp_port_get_info (GPPort *port, GPPortInfo *info);
157 
158 int gp_port_open (GPPort *port);
159 int gp_port_close (GPPort *port);
160 
161 int gp_port_reset (GPPort *port);
162 
163 int gp_port_write (GPPort *port, const char *data, int size);
164 int gp_port_read (GPPort *port, char *data, int size);
165 int gp_port_check_int (GPPort *port, char *data, int size);
166 int gp_port_check_int_fast (GPPort *port, char *data, int size);
167 
168 int gp_port_get_timeout (GPPort *port, int *timeout);
169 int gp_port_set_timeout (GPPort *port, int timeout);
170 
171 int gp_port_set_settings (GPPort *port, GPPortSettings settings);
172 int gp_port_get_settings (GPPort *port, GPPortSettings *settings);
173 
180 typedef enum _GPPin {
186  GP_PIN_RING
188 
194 typedef enum _GPLevel {
196  GP_LEVEL_HIGH = 1
198 
199 int gp_port_get_pin (GPPort *port, GPPin pin, GPLevel *level);
200 int gp_port_set_pin (GPPort *port, GPPin pin, GPLevel level);
201 
202 int gp_port_send_break (GPPort *port, int duration);
203 int gp_port_flush (GPPort *port, int direction);
204 
205 int gp_port_usb_find_device (GPPort *port, int idvendor, int idproduct);
206 int gp_port_usb_find_device_by_class (GPPort *port, int mainclass, int subclass, int protocol);
207 int gp_port_usb_clear_halt (GPPort *port, int ep);
208 int gp_port_usb_msg_write (GPPort *port, int request, int value,
209  int index, char *bytes, int size);
210 int gp_port_usb_msg_read (GPPort *port, int request, int value,
211  int index, char *bytes, int size);
212 int gp_port_usb_msg_interface_write (GPPort *port, int request,
213  int value, int index, char *bytes, int size);
214 int gp_port_usb_msg_interface_read (GPPort *port, int request,
215  int value, int index, char *bytes, int size);
216 int gp_port_usb_msg_class_write (GPPort *port, int request,
217  int value, int index, char *bytes, int size);
218 int gp_port_usb_msg_class_read (GPPort *port, int request,
219  int value, int index, char *bytes, int size);
220 
221 int gp_port_seek (GPPort *port, int offset, int whence);
222 
223 int gp_port_send_scsi_cmd (GPPort *port, int to_dev,
224  char *cmd, int cmd_size,
225  char *sense, int sense_size,
226  char *data, int data_size);
227 
228 /* Error reporting */
229 int gp_port_set_error (GPPort *port, const char *format, ...)
230 #ifdef __GNUC__
231  __attribute__((__format__(printf,2,3)))
232 #endif
233 ;
234 const char *gp_port_get_error (GPPort *port);
235 
236 /* DEPRECATED */
238 typedef GPPort gp_port;
242 #define PIN_CTS GP_PIN_CTS
243 
244 #ifdef __cplusplus
245 }
246 #endif /* __cplusplus */
247 
248 #endif /* !defined(LIBGPHOTO2_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:884
_GPPortSettingsSerial::parity
GPPortSerialParity parity
Definition: gphoto2-port.h:66
gp_port_get_info
int gp_port_get_info(GPPort *port, GPPortInfo *info)
Retreives information about the port.
Definition: gphoto2-port.c:242
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:924
gp_port_settings
GPPortSettings gp_port_settings
Definition: gphoto2-port.h:240
gp_port_get_settings
int gp_port_get_settings(GPPort *port, GPPortSettings *settings)
Get the current port settings.
Definition: gphoto2-port.c:619
_GPPortSettingsUsbScsi::path
char path[128]
Definition: gphoto2-port.h:101
gp_port
GPPort gp_port
Definition: gphoto2-port.h:238
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:638
GP_PIN_DTR
@ GP_PIN_DTR
DTR line.
Definition: gphoto2-port.h:182
_GPPortSettingsUsbScsi
Port settings for USB Mass Storage raw SCSI ports.
Definition: gphoto2-port.h:100
gp_port_new
int gp_port_new(GPPort **port)
Create new GPPort.
Definition: gphoto2-port.c:81
gp_port_flush
int gp_port_flush(GPPort *port, int direction)
Flush data on serial port.
Definition: gphoto2-port.c:749
gp_port_set_info
int gp_port_set_info(GPPort *port, GPPortInfo info)
Configure a port.
Definition: gphoto2-port.c:136
gp_port_set_settings
int gp_port_set_settings(GPPort *port, GPPortSettings settings)
Set port settings.
Definition: gphoto2-port.c:577
_GPPortSettings::usbdiskdirect
GPPortSettingsUsbDiskDirect usbdiskdirect
usb disk direct port specific settings
Definition: gphoto2-port.h:113
_GPPort::pc
GPPortPrivateCore * pc
Port library private data pointer.
Definition: gphoto2-port.h:149
GPPortSerialParity
enum _GPPortSerialParity GPPortSerialParity
Serial parity.
_GPPortSettingsUSB::intep
int intep
Interrupt endpoint used.
Definition: gphoto2-port.h:77
gp_port_check_int
int gp_port_check_int(GPPort *port, char *data, int size)
Check for intterupt.
Definition: gphoto2-port.c:450
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:184
_GPPortSettingsUSB
Port settings for USB ports.
Definition: gphoto2-port.h:74
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:690
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:777
GP_PIN_CTS
@ GP_PIN_CTS
CTS line.
Definition: gphoto2-port.h:183
gp_port_open
int gp_port_open(GPPort *port)
Open a port.
Definition: gphoto2-port.c:260
_GPPortSettingsUSB::maxpacketsize
int maxpacketsize
Maximum USB packetsize of the IN endpoint. (r/o)
Definition: gphoto2-port.h:82
GP_PIN_RING
@ GP_PIN_RING
RING (Modem) line.
Definition: gphoto2-port.h:186
_GPPortSettingsUSB::config
int config
USB bConfigurationValue used.
Definition: gphoto2-port.h:78
gp_port_free
int gp_port_free(GPPort *port)
Free the port structure.
Definition: gphoto2-port.c:328
gp_port_read
int gp_port_read(GPPort *port, char *data, int size)
Read data from port.
Definition: gphoto2-port.c:414
_GPPort
The GPhoto port structure.
Definition: gphoto2-port.h:139
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:851
gp_port_set_timeout
int gp_port_set_timeout(GPPort *port, int timeout)
Set timeout of port.
Definition: gphoto2-port.c:521
_GPPort::settings_pending
GPPortSettings settings_pending
Settings to be committed.
Definition: gphoto2-port.h:144
_GPPortSettings::serial
GPPortSettingsSerial serial
Serial specific settings.
Definition: gphoto2-port.h:111
GP_PIN_CD
@ GP_PIN_CD
Carrier Detect line.
Definition: gphoto2-port.h:185
_GPPortSettings::usb
GPPortSettingsUSB usb
USB specific settings.
Definition: gphoto2-port.h:112
_GPPortPrivateCore
Internal private libgphoto2_port data. This structure contains private data.
Definition: gphoto2-port.c:60
_GPPortSettingsUSB::inep
int inep
Bulk IN endpoint used.
Definition: gphoto2-port.h:75
GP_PIN_RTS
@ GP_PIN_RTS
RTS line.
Definition: gphoto2-port.h:181
gp_port_get_error
const char * gp_port_get_error(GPPort *port)
Get verbose port error message.
Definition: gphoto2-port.c:1197
gp_port_reset
int gp_port_reset(GPPort *port)
Reset a port.
Definition: gphoto2-port.c:306
gp_port_close
int gp_port_close(GPPort *port)
Close a port.
Definition: gphoto2-port.c:284
GPPortSettingsUSB
struct _GPPortSettingsUSB GPPortSettingsUSB
Port settings for USB ports.
_GPPortSettingsUsbDiskDirect
Port settings for USB mass storage direct IO ports.
Definition: gphoto2-port.h:93
GP_PORT_SERIAL_PARITY_ODD
@ GP_PORT_SERIAL_PARITY_ODD
Parity is odd.
Definition: gphoto2-port.h:53
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:1105
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:1002
_GPPin
_GPPin
Serial pins.
Definition: gphoto2-port.h:180
_GPPortSerialParity
_GPPortSerialParity
Serial parity.
Definition: gphoto2-port.h:50
gp_port_usb_clear_halt
int gp_port_usb_clear_halt(GPPort *port, int ep)
Clear USB endpoint HALT condition.
Definition: gphoto2-port.c:823
GPLevel
enum _GPLevel GPLevel
Level to pull specific lines.
GP_PORT_USB_ENDPOINT_OUT
@ GP_PORT_USB_ENDPOINT_OUT
USB bulk OUT ep.
Definition: gphoto2-port.h:119
gp_port_send_break
int gp_port_send_break(GPPort *port, int duration)
Send a break over a serial port.
Definition: gphoto2-port.c:724
_GPPortSettingsUSB::outep
int outep
Bulk OUT endpoint used.
Definition: gphoto2-port.h:76
GPPin
enum _GPPin GPPin
Serial pins.
_GPLevel
_GPLevel
Level to pull specific lines.
Definition: gphoto2-port.h:194
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:1071
_GPPortSettingsUSB::port
char port[64]
USB Portname. Specific to lowlevel USB.
Definition: gphoto2-port.h:87
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:1037
_GPPortSettings
Union of port settings.
Definition: gphoto2-port.h:110
GP_LEVEL_HIGH
@ GP_LEVEL_HIGH
Pull to high (nV)
Definition: gphoto2-port.h:196
_GPPortSettings::usbscsi
GPPortSettingsUsbScsi usbscsi
usb scsi port specific settings
Definition: gphoto2-port.h:114
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:959
gphoto2-port-info-list.h
GP_PORT_SERIAL_PARITY_EVEN
@ GP_PORT_SERIAL_PARITY_EVEN
Parity is even.
Definition: gphoto2-port.h:52
GP_LEVEL_LOW
@ GP_LEVEL_LOW
Pull to low (0V)
Definition: gphoto2-port.h:195
GP_PORT_USB_ENDPOINT_IN
@ GP_PORT_USB_ENDPOINT_IN
USB bulk IN ep.
Definition: gphoto2-port.h:118
gp_port_set_error
int gp_port_set_error(GPPort *port, const char *format,...)
Set verbose port error message.
Definition: gphoto2-port.c:1167
_GPPort::pl
GPPortPrivateLibrary * pl
Camera driver private data pointer.
Definition: gphoto2-port.h:148
_GPPortSettingsUsbDiskDirect::path
char path[128]
Definition: gphoto2-port.h:94
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:801
_GPPortSettingsSerial
Port settings for serial ports.
Definition: gphoto2-port.h:62
_GPPortSettingsUSB::altsetting
int altsetting
USB Alternative Setting used.
Definition: gphoto2-port.h:80
_GPPortSettingsSerial::bits
int bits
Definition: gphoto2-port.h:65
_GPPort::timeout
int timeout
Port timeout in milliseconds.
Definition: gphoto2-port.h:146
GP_PORT_USB_ENDPOINT_INT
@ GP_PORT_USB_ENDPOINT_INT
USB Interrupt ep.
Definition: gphoto2-port.h:120
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:483
_GPPort::settings
GPPortSettings settings
Current port settings.
Definition: gphoto2-port.h:143
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:379
GPPortSettingsSerial
struct _GPPortSettingsSerial GPPortSettingsSerial
Port settings for serial ports.
_GPPortSettingsSerial::port
char port[128]
Definition: gphoto2-port.h:63
_GPPort::type
GPPortType type
Actual type of this port.
Definition: gphoto2-port.h:141
_GPPortSettingsSerial::stopbits
int stopbits
Definition: gphoto2-port.h:68
_GPPortSettingsUSB::interface
int interface
USB Interface number used.
Definition: gphoto2-port.h:79
gp_port_get_timeout
int gp_port_get_timeout(GPPort *port, int *timeout)
Get the current port timeout.
Definition: gphoto2-port.c:555
GP_PORT_SERIAL_PARITY_OFF
@ GP_PORT_SERIAL_PARITY_OFF
Parity is off (disabled)
Definition: gphoto2-port.h:51
_GPPortSettingsSerial::speed
int speed
Definition: gphoto2-port.h:64
GPPortType
GPPortType
The gphoto port type.
Definition: gphoto2-port-info-list.h:34