developer.intra2net.com Git - libftdi/blob - python/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 inline PyObject* charp2str(const char *v_, long 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 inline char * str2charp_size(PyObject* pyObj, int * size)
  23 {
  24   char * v_ = 0;
  25 #if PY_MAJOR_VERSION >= 3
  26   PyBytes_AsStringAndSize(pyObj, &v_, (Py_ssize_t*)size);
  27 #else
  28   PyString_AsStringAndSize(pyObj, &v_, (Py_ssize_t*)size);
  29 #endif
  30   return v_;
  31 }
  32 %}
  33
  34 %include <typemaps.i>
  35 %include <cstring.i>
  36
  37 %typemap(in) unsigned char* = char*;
  38
  39 %immutable ftdi_version_info::version_str;
  40 %immutable ftdi_version_info::snapshot_str;
  41
  42 %rename("%(strip:[ftdi_])s") "";
  43
  44 %newobject ftdi_new;
  45 %typemap(newfree) struct ftdi_context *ftdi "ftdi_free($1);";
  46 %delobject ftdi_free;
  47
  48 %define ftdi_usb_find_all_docstring
  49 "usb_find_all(context, vendor, product) -> (return_code, devlist)"
  50 %enddef
  51 %feature("autodoc", ftdi_usb_find_all_docstring) ftdi_usb_find_all;
  52 %typemap(in,numinputs=0) SWIGTYPE** OUTPUT ($*ltype temp) %{ $1 = &temp; %}
  53 %typemap(argout) SWIGTYPE** OUTPUT %{ $result = SWIG_Python_AppendOutput($result, SWIG_NewPointerObj((void*)*$1,$*descriptor,0)); %}
  54 %apply SWIGTYPE** OUTPUT { struct ftdi_device_list **devlist };
  55     int ftdi_usb_find_all(struct ftdi_context *ftdi, struct ftdi_device_list **devlist,
  56                           int vendor, int product);
  57 %clear struct ftdi_device_list **devlist;
  58
  59 %define ftdi_usb_get_strings_docstring
  60 "usb_get_strings(context, device) -> (return_code, manufacturer, description, serial)"
  61 %enddef
  62 %feature("autodoc", ftdi_usb_get_strings_docstring) ftdi_usb_get_strings;
  63 %feature("autodoc", ftdi_usb_get_strings_docstring) ftdi_usb_get_strings2;
  64 %feature("autodoc", ftdi_usb_get_strings_docstring) ftdi_eeprom_get_strings;
  65 %apply char *OUTPUT { char * manufacturer, char * description, char * serial };
  66 %cstring_bounded_output( char * manufacturer, 256 );
  67 %cstring_bounded_output( char * description, 256 );
  68 %cstring_bounded_output( char * product, 256 );
  69 %cstring_bounded_output( char * serial, 256 );
  70 %typemap(default,noblock=1) int mnf_len, int desc_len, int product_len, int serial_len { $1 = 256; }
  71     int ftdi_usb_get_strings(struct ftdi_context *ftdi, struct libusb_device *dev,
  72                              char * manufacturer, int mnf_len,
  73                              char * description, int desc_len,
  74                              char * serial, int serial_len);
  75     int ftdi_usb_get_strings2(struct ftdi_context *ftdi, struct libusb_device *dev,
  76                               char * manufacturer, int mnf_len,
  77                               char * description, int desc_len,
  78                               char * serial, int serial_len);
  79     int ftdi_eeprom_get_strings(struct ftdi_context *ftdi,
  80                                 char *manufacturer, int mnf_len,
  81                                 char *product, int product_len,
  82                                 char *serial, int serial_len);
  83
  84 %clear char * manufacturer, char * description, char * serial;
  85 %clear char * product;
  86 %clear int mnf_len, int desc_len, int product_len, int serial_len;
  87
  88 %define ftdi_read_data_docstring
  89 "read_data(context) -> (return_code, buf)"
  90 %enddef
  91 %feature("autodoc", ftdi_read_data_docstring) ftdi_read_data;
  92 %typemap(in,numinputs=1) (unsigned char *buf, int size) %{ $2 = PyInt_AsLong($input);$1 = (unsigned char*)malloc($2*sizeof(char)); %}
  93 %typemap(argout) (unsigned char *buf, int size) %{ if(result<0) $2=0; $result = SWIG_Python_AppendOutput($result, charp2str((char*)$1, $2)); free($1); %}
  94     int ftdi_read_data(struct ftdi_context *ftdi, unsigned char *buf, int size);
  95 %clear (unsigned char *buf, int size);
  96
  97 %define ftdi_write_data_docstring
  98 "write_data(context, data) -> return_code"
  99 %enddef
 100 %feature("autodoc", ftdi_write_data_docstring) ftdi_write_data;
 101 %typemap(in,numinputs=1) (const unsigned char *buf, int size) %{ $1 = (unsigned char*)str2charp_size($input, &$2); %}
 102     int ftdi_write_data(struct ftdi_context *ftdi, const unsigned char *buf, int size);
 103 %clear (const unsigned char *buf, int size);
 104
 105 %apply int *OUTPUT { unsigned int *chunksize };
 106     int ftdi_read_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize);
 107     int ftdi_write_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize);
 108 %clear unsigned int *chunksize;
 109
 110 %define ftdi_read_pins_docstring
 111 "read_pins(context) -> (return_code, pins)"
 112 %enddef
 113 %feature("autodoc", ftdi_read_pins_docstring) ftdi_read_pins;
 114 %typemap(in,numinputs=0) unsigned char *pins ($*ltype temp) %{ $1 = &temp; %}
 115 %typemap(argout) (unsigned char *pins) %{ $result = SWIG_Python_AppendOutput($result, charp2str((char*)$1, 1)); %}
 116     int ftdi_read_pins(struct ftdi_context *ftdi, unsigned char *pins);
 117 %clear unsigned char *pins;
 118
 119 %typemap(in,numinputs=0) unsigned char *latency ($*ltype temp) %{ $1 = &temp; %}
 120 %typemap(argout) (unsigned char *latency) %{ $result = SWIG_Python_AppendOutput($result, charp2str((char*)$1, 1)); %}
 121     int ftdi_get_latency_timer(struct ftdi_context *ftdi, unsigned char *latency);
 122 %clear unsigned char *latency;
 123
 124 %apply short *OUTPUT { unsigned short *status };
 125     int ftdi_poll_modem_status(struct ftdi_context *ftdi, unsigned short *status);
 126 %clear unsigned short *status;
 127
 128 %apply int *OUTPUT { int* value };
 129     int ftdi_get_eeprom_value(struct ftdi_context *ftdi, enum ftdi_eeprom_value value_name, int* value);
 130 %clear int* value;
 131
 132 %typemap(in,numinputs=1) (unsigned char *buf, int size) %{ $2 = PyInt_AsLong($input);$1 = (unsigned char*)malloc($2*sizeof(char)); %}
 133 %typemap(argout) (unsigned char *buf, int size) %{ if(result<0) $2=0; $result = SWIG_Python_AppendOutput($result, charp2str((char*)$1, $2)); free($1); %}
 134     int ftdi_get_eeprom_buf(struct ftdi_context *ftdi, unsigned char * buf, int size);
 135 %clear (unsigned char *buf, int size);
 136
 137 %define ftdi_read_eeprom_location_docstring
 138 "read_eeprom_location(context, eeprom_addr) -> (return_code, eeprom_val)"
 139 %enddef
 140 %feature("autodoc", ftdi_read_eeprom_location_docstring) ftdi_read_eeprom_location;
 141 %apply short *OUTPUT { unsigned short *eeprom_val };
 142     int ftdi_read_eeprom_location (struct ftdi_context *ftdi, int eeprom_addr, unsigned short *eeprom_val);
 143 %clear unsigned short *eeprom_val;
 144
 145 %define ftdi_read_eeprom_docstring
 146 "read_eeprom(context) -> (return_code, eeprom)"
 147 %enddef
 148 %feature("autodoc", ftdi_read_eeprom_docstring) ftdi_read_eeprom;
 149
 150 %define ftdi_read_chipid_docstring
 151 "ftdi_read_chipid(context) -> (return_code, chipid)"
 152 %enddef
 153 %feature("autodoc", ftdi_read_chipid_docstring) ftdi_read_chipid;
 154 %apply int *OUTPUT { unsigned int *chipid };
 155     int ftdi_read_chipid(struct ftdi_context *ftdi, unsigned int *chipid);
 156 %clear unsigned int *chipid;
 157
 158 %include ftdi.h
 159 %{
 160 #include <ftdi.h>
 161 %}
 162
 163 %include ftdi_i.h
 164 %{
 165 #include <ftdi_i.h>
 166 %}
 167
 168 %pythoncode %{
 169 __version__ = get_library_version().version_str
 170 %}