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