Added version attribute.
[libftdi] / bindings / ftdi1.i
1 /* File: ftdi1.i */
2
3 %module(docstring="Python interface to libftdi1") ftdi1
4 %feature("autodoc","1");
5
6 #ifdef DOXYGEN
7 %include "ftdi1_doc.i"
8 #endif
9
10 %{
11 #include "Python.h"
12
13 PyObject* convertString( const char *v, Py_ssize_t len )
14 {
15 #if PY_MAJOR_VERSION >= 3
16   return PyBytes_FromStringAndSize(v, len);
17 #else
18   return PyString_FromStringAndSize(v, len);
19 #endif
20 }
21 %}
22
23 %include <typemaps.i>
24 %include <cstring.i>
25
26 %typemap(in) unsigned char* = char*;
27
28 %immutable ftdi_version_info::version_str;
29 %immutable ftdi_version_info::snapshot_str;
30
31 %rename("%(strip:[ftdi_])s") "";
32
33 %newobject ftdi_new;
34 %typemap(newfree) struct ftdi_context *ftdi "ftdi_free($1);";
35 %delobject ftdi_free;
36
37 %define ftdi_usb_find_all_docstring
38 "usb_find_all(context, vendor, product) -> (return_code, devlist)"
39 %enddef
40 %feature("autodoc", ftdi_usb_find_all_docstring) ftdi_usb_find_all;
41 %typemap(in,numinputs=0) SWIGTYPE** OUTPUT ($*ltype temp) %{ $1 = &temp; %}
42 %typemap(argout) SWIGTYPE** OUTPUT %{ $result = SWIG_Python_AppendOutput($result, SWIG_NewPointerObj((void*)*$1,$*descriptor,0)); %}
43 %apply SWIGTYPE** OUTPUT { struct ftdi_device_list **devlist };
44     int ftdi_usb_find_all(struct ftdi_context *ftdi, struct ftdi_device_list **devlist,
45                           int vendor, int product);
46 %clear struct ftdi_device_list **devlist;
47
48 %define ftdi_usb_get_strings_docstring
49 "usb_get_strings(context, device) -> (return_code, manufacturer, description, serial)"
50 %enddef
51 %feature("autodoc", ftdi_usb_get_strings_docstring) ftdi_usb_get_strings;
52 %apply char *OUTPUT { char * manufacturer, char * description, char * serial };
53 %cstring_bounded_output( char * manufacturer, 256 );
54 %cstring_bounded_output( char * description, 256 );
55 %cstring_bounded_output( char * serial, 256 );
56 %typemap(default,noblock=1) int mnf_len, int desc_len, int serial_len { $1 = 256; }
57     int ftdi_usb_get_strings(struct ftdi_context *ftdi, struct libusb_device *dev,
58                              char * manufacturer, int mnf_len,
59                              char * description, int desc_len,
60                              char * serial, int serial_len);
61 %clear char * manufacturer, char * description, char * serial;
62 %clear int mnf_len, int desc_len, int serial_len;
63
64 %define ftdi_read_data_docstring
65 "read_data(context) -> (return_code, buf)"
66 %enddef
67 %feature("autodoc", ftdi_read_data_docstring) ftdi_read_data;
68 %typemap(in,numinputs=1) (unsigned char *buf, int size) %{ $2 = PyInt_AsLong($input);$1 = (unsigned char*)malloc($2*sizeof(char)); %}
69 %typemap(argout) (unsigned char *buf, int size) %{ if(result<0) $2=0; $result = SWIG_Python_AppendOutput($result, convertString((char*)$1, $2)); free($1); %}
70     int ftdi_read_data(struct ftdi_context *ftdi, unsigned char *buf, int size);
71 %clear (unsigned char *buf, int size);
72
73 %apply int *OUTPUT { unsigned int *chunksize };
74     int ftdi_read_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize);
75     int ftdi_write_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize);
76 %clear unsigned int *chunksize;
77
78 %define ftdi_read_pins_docstring
79 "read_pins(context) -> (return_code, pins)"
80 %enddef
81 %feature("autodoc", ftdi_read_pins_docstring) ftdi_read_pins;
82 %apply char *OUTPUT { unsigned char *pins };
83     int ftdi_read_pins(struct ftdi_context *ftdi, unsigned char *pins);
84 %clear unsigned char *pins;
85
86 %apply char *OUTPUT { unsigned char *latency };
87     int ftdi_get_latency_timer(struct ftdi_context *ftdi, unsigned char *latency);
88 %clear unsigned char *latency;
89
90 %apply short *OUTPUT { unsigned short *status };
91     int ftdi_poll_modem_status(struct ftdi_context *ftdi, unsigned short *status);
92 %clear unsigned short *status;
93
94 %apply int *OUTPUT { int* value };
95     int ftdi_get_eeprom_value(struct ftdi_context *ftdi, enum ftdi_eeprom_value value_name, int* value);
96 %clear int* value;
97
98 %typemap(in,numinputs=1) (unsigned char *buf, int size) %{ $2 = PyInt_AsLong($input);$1 = (unsigned char*)malloc($2*sizeof(char)); %}
99 %typemap(argout) (unsigned char *buf, int size) %{ if(result<0) $2=0; $result = SWIG_Python_AppendOutput($result, convertString((char*)$1, $2)); free($1); %}
100     int ftdi_get_eeprom_buf(struct ftdi_context *ftdi, unsigned char * buf, int size);
101 %clear (unsigned char *buf, int size);
102
103 %define ftdi_read_eeprom_location_docstring
104 "read_eeprom_location(context, eeprom_addr) -> (return_code, eeprom_val)"
105 %enddef
106 %feature("autodoc", ftdi_read_eeprom_location_docstring) ftdi_read_eeprom_location;
107 %apply short *OUTPUT { unsigned short *eeprom_val };
108     int ftdi_read_eeprom_location (struct ftdi_context *ftdi, int eeprom_addr, unsigned short *eeprom_val);
109 %clear unsigned short *eeprom_val;
110
111 %define ftdi_read_eeprom_docstring
112 "read_eeprom(context) -> (return_code, eeprom)"
113 %enddef
114 %feature("autodoc", ftdi_read_eeprom_docstring) ftdi_read_eeprom;
115
116 %define ftdi_read_chipid_docstring
117 "read_pins(context) -> (return_code, chipid)"
118 %enddef
119 %feature("autodoc", ftdi_read_chipid_docstring) ftdi_read_chipid;
120 %apply int *OUTPUT { unsigned int *chipid };
121     int ftdi_read_chipid(struct ftdi_context *ftdi, unsigned int *chipid);
122 %clear unsigned int *chipid;
123
124 %include ftdi.h
125 %{
126 #include <ftdi.h>
127 %}
128
129 %include ftdi_i.h
130 %{
131 #include <ftdi_i.h>
132 %}
133
134 %pythoncode %{
135 __version__ = get_library_version().version_str
136 %}