libgphoto2 photo camera library (libgphoto2) API  2.4.14
gphoto2-port.h
Go to the documentation of this file.
1 
24 #ifndef __GPHOTO2_PORT_H__
25 #define __GPHOTO2_PORT_H__
26 
28 
29 /* For portability */
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 {
59 
61 #define GP_PORT_MAX_BUF_LEN 4096
62 
66 typedef struct _GPPortSettingsSerial {
67  char port[128];
68  int speed;
69  int bits;
72  int stopbits;
74 
78 typedef struct _GPPortSettingsUSB {
79  int inep;
80  int outep;
81  int intep;
82  int config;
83  int interface;
84  int altsetting;
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];
93 
97 typedef struct _GPPortSettingsDisk {
98  char mountpoint[128];
100 
105  char path[128];
107 
111 typedef struct _GPPortSettingsUsbScsi {
112  char path[128];
114 
121 typedef union _GPPortSettings {
128 
129 enum {
133 };
134 
135 typedef struct _GPPortPrivateLibrary GPPortPrivateLibrary;
137 
151 typedef struct _GPPort {
152  /* For your convenience */
158  int timeout;
160  GPPortPrivateLibrary *pl;
162 } GPPort;
163 
164 int gp_port_new (GPPort **port);
165 int gp_port_free (GPPort *port);
166 
167 int gp_port_set_info (GPPort *port, GPPortInfo info);
168 int gp_port_get_info (GPPort *port, GPPortInfo *info);
169 
170 int gp_port_open (GPPort *port);
171 int gp_port_close (GPPort *port);
172 
173 int gp_port_write (GPPort *port, const char *data, int size);
174 int gp_port_read (GPPort *port, char *data, int size);
175 int gp_port_check_int (GPPort *port, char *data, int size);
176 int gp_port_check_int_fast (GPPort *port, char *data, int size);
177 
178 int gp_port_get_timeout (GPPort *port, int *timeout);
179 int gp_port_set_timeout (GPPort *port, int timeout);
180 
181 int gp_port_set_settings (GPPort *port, GPPortSettings settings);
182 int gp_port_get_settings (GPPort *port, GPPortSettings *settings);
183 
190 typedef enum _GPPin {
197 } GPPin;
198 
204 typedef enum _GPLevel {
207 } GPLevel;
208 
209 int gp_port_get_pin (GPPort *port, GPPin pin, GPLevel *level);
210 int gp_port_set_pin (GPPort *port, GPPin pin, GPLevel level);
211 
212 int gp_port_send_break (GPPort *port, int duration);
213 int gp_port_flush (GPPort *port, int direction);
214 
215 int gp_port_usb_find_device (GPPort *port, int idvendor, int idproduct);
216 int gp_port_usb_find_device_by_class (GPPort *port, int mainclass, int subclass, int protocol);
217 int gp_port_usb_clear_halt (GPPort *port, int ep);
218 int gp_port_usb_msg_write (GPPort *port, int request, int value,
219  int index, char *bytes, int size);
220 int gp_port_usb_msg_read (GPPort *port, int request, int value,
221  int index, char *bytes, int size);
222 int gp_port_usb_msg_interface_write (GPPort *port, int request,
223  int value, int index, char *bytes, int size);
224 int gp_port_usb_msg_interface_read (GPPort *port, int request,
225  int value, int index, char *bytes, int size);
226 int gp_port_usb_msg_class_write (GPPort *port, int request,
227  int value, int index, char *bytes, int size);
228 int gp_port_usb_msg_class_read (GPPort *port, int request,
229  int value, int index, char *bytes, int size);
230 
231 int gp_port_seek (GPPort *port, int offset, int whence);
232 
233 int gp_port_send_scsi_cmd (GPPort *port, int to_dev,
234  char *cmd, int cmd_size,
235  char *sense, int sense_size,
236  char *data, int data_size);
237 
238 /* Error reporting */
239 int gp_port_set_error (GPPort *port, const char *format, ...)
240 #ifdef __GNUC__
241  __attribute__((__format__(printf,2,3)))
242 #endif
243 ;
244 const char *gp_port_get_error (GPPort *port);
245 
246 /* DEPRECATED */
248 typedef GPPort gp_port;
252 #define PIN_CTS GP_PIN_CTS
253 
254 #ifdef __cplusplus
255 }
256 #endif /* __cplusplus */
257 
258 #endif /* __GPHOTO2_PORT_H__ */
259 
260