siso_auxport.h

Go to the documentation of this file.

 
#pragma once
#ifndef SISO_AUX_PORT_H
#define SISO_AUX_PORT_H
 
#include <cstring>
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
enum SisoAuxPortType_Enum {
    SISO_AUX_PORT_ANY,  
    SISO_AUX_PORT_JTAG, 
    SISO_AUX_PORT_I2C,  
    SISO_AUX_PORT_UIQ,  
    SISO_AUX_PORT_SPI   
};
 
typedef enum SisoAuxPortType_Enum SisoAuxPortType;
 
 
int SisoAuxPortGetNumberOfPorts(unsigned int board_id, SisoAuxPortType port_type);
 
int SisoAuxPortGetFirstNumberOfType(unsigned int board_id, SisoAuxPortType port_type);
 
int SisoAuxPortGetType(unsigned int board_id, unsigned int port_num, SisoAuxPortType * type_ptr);
 
typedef struct SisoAuxPort_Struct * SisoAuxPort;
 
 
int SisoAuxPortInit(unsigned int board_id, unsigned int port_num, SisoAuxPortType type, SisoAuxPort * handle_ptr);
 
int SisoAuxPortOpen(SisoAuxPort handle);
 
int SisoAuxPortClose(SisoAuxPort handle);
 
int SisoAuxPortFree(SisoAuxPort handle);
 
enum SisoAuxPortPropertyType_Enum {
    SISO_AUX_PORT_PROPERTY_TYPE_INT,    
    SISO_AUX_PORT_PROPERTY_TYPE_FLOAT,  
    SISO_AUX_PORT_PROPERTY_TYPE_STRING, 
    SISO_AUX_PORT_PROPERTY_TYPE_BINARY  
};
 
typedef SisoAuxPortPropertyType_Enum SisoAuxPortPropertyType;
 
 
/* Integer properties */
#define SISO_AUX_PORT_INT_PROPERTY_FREQUENCY "Frequency:Int" 
/* Float properties */
#define SISO_AUX_PORT_FLOAT_PROPERTY_FREQUENCY "Frequency:Float" 
/* String properties */
#define SISO_AUX_PORT_STRING_PROPERTY_NAME "Name:Str" 
#define SISO_AUX_PORT_STRING_PROPERTY_TYPE "Type:Str" 
/* JTAG port integer properties */
#define SISO_JTAG_PORT_INT_PROPERTY_NUM_TAPS "JTAGNumTaps:Int" 
#define SISO_JTAG_PORT_INT_PROPERTY_STATE "JTAGState:Int" 
/* JTAG port binary properties */
#define SISO_JTAG_PORT_BINARY_PROPERTY_CHAIN "JTAGChain:Bin" 
/* UIQ port properties */
#define SISO_UIQ_PORT_INT_PROPERTY_TRANSMISSION_MODE "UiqTransmissionMode:Int"  
#define SISO_UIQ_PORT_INT_PROPERTY_SPI_MODE "UiqSpiMode:Int"                    
#define SISO_UIQ_PORT_INT_PROPERTY_NUM_WORDS_AVAILABLE "UiqNumWords:Int"        
 
 
 
#define SISO_JTAG_PORT_STATE_RESET    0 
#define SISO_JTAG_PORT_STATE_IDLE     1 
#define SISO_JTAG_PORT_STATE_SHIFT_DR 2 
#define SISO_JTAG_PORT_STATE_SHIFT_IR 3 
 
 
 
/* JTAG invalid device id */
#define SISO_JTAG_PORT_DEVICE_ID_NONE      0  
#define SISO_JTAG_PORT_DEVICE_ID_INVALID (-1) 
 
 
struct SisoJTAGTAP_Struct {
    unsigned int ir_length;     
    unsigned int device_id;     
};
 
struct SisoJTAGChain_Struct {
    size_t num_taps;            
    SisoJTAGTAP_Struct tap[1];  
};
 
 
int SisoAuxPortGetProperty(SisoAuxPort handle, const char * property, SisoAuxPortPropertyType type, void * value, unsigned int size);
 
int SisoAuxPortSetProperty(SisoAuxPort handle, const char * property, SisoAuxPortPropertyType type, void * value, unsigned int size);
 
 
/* General transmission flags */
#define SISO_AUX_PORT_RWFLAGS_LENGTH_IN_BYTES (0x1) 
#define SISO_AUX_PORT_RWFLAGS_LENGTH_IN_BITS  (0x2) 
/* JTAG port transmission flags */
#define SISO_JTAG_PORT_RWFLAGS_USE_DEVICE_ID           0  
#define SISO_JTAG_PORT_RWFLAGS_USE_TAP_NUMBER      (0x10) 
#define SISO_JTAG_PORT_RWFLAGS_WAIT_ON_READ            0  
#define SISO_JTAG_PORT_RWFLAGS_SEND_ZEROES_ON_READ (0x20) 
#define SISO_JTAG_PORT_RWFLAGS_RAW_SEND_ZEROES_ON_OTHER SISO_JTAG_PORT_RWFLAGS_SEND_ZEROES_ON_READ 
#define SISO_JTAG_PORT_RWFLAGS_SEND_ONES_ON_READ   (0x40) 
#define SISO_JTAG_PORT_RWFLAGS_RAW_SEND_ONES_ON_OTHER SISO_JTAG_PORT_RWFLAGS_SEND_ONES_ON_READ 
#define SISO_JTAG_PORT_RWFLAGS_READ_MODE_MASK      (0x60) 
#define SISO_JTAG_PORT_RWFLAGS_RAW_MODE            (0x80) 
#define SISO_JTAG_PORT_RWFLAGS_STATE_IDLE         (0x100) 
#define SISO_JTAG_PORT_RWFLAGS_STATE_SHIFT_DR     (0x200) 
#define SISO_JTAG_PORT_RWFLAGS_STATE_SHIFT_IR     (0x300) 
#define SISO_JTAG_PORT_RWFLAGS_STATE_MASK         (0x300) 
#define SISO_JTAG_PORT_RWFLAGS_MSB_FIRST                0 
#define SISO_JTAG_PORT_RWFLAGS_LSB_FIRST          (0x400) 
#define SISO_JTAG_PORT_RWFLAGS_RAW_WRITE_TDI_DATA       0 
#define SISO_JTAG_PORT_RWFLAGS_RAW_WRITE_TMS_DATA (0x800) 
/* I2C port transmission flags */
#define SISO_I2C_PORT_RWFLAGS_SEND_START               0  
#define SISO_I2C_PORT_RWFLAGS_DONT_SEND_START    (0x1000) 
#define SISO_I2C_PORT_RWFLAGS_SEND_STOP                0  
#define SISO_I2C_PORT_RWFLAGS_DONT_SEND_STOP     (0x2000) 
#define SISO_I2C_PORT_RWFLAGS_NAK_LAST_BYTE_READ       0  
#define SISO_I2C_PORT_RWFLAGS_ACK_LAST_BYTE_READ (0x4000) 
#define SISO_I2C_PORT_RWFLAGS_ACK_POLLING        (0x8000) 
 
 
enum SisoAuxPortFlushType_Enum {
    SISO_AUX_PORT_FLUSH_ALL,
    SISO_AUX_PORT_FLUSH_INPUT,
    SISO_AUX_PORT_FLUSH_OUTPUT
};
 
typedef enum SisoAuxPortFlushType_Enum SisoAuxPortFlushType;
 
 
int SisoAuxPortWrite(SisoAuxPort handle, const void * data, unsigned int size, unsigned int * length_ptr, unsigned int flags, unsigned int timeout);
 
int SisoAuxPortRead(SisoAuxPort handle, void * data, unsigned int size, unsigned int * length_ptr, unsigned int flags, unsigned int timeout);
 
int SisoAuxPortFlush(SisoAuxPort handle, SisoAuxPortFlushType flush, unsigned int timeout);
 
int SisoAuxPortBeginTransferBlock(SisoAuxPort handle, unsigned int timeout);
 
int SisoAuxPortEndTransferBlock(SisoAuxPort handle);
 
 
 
int SisoAuxPortSend(SisoAuxPort handle, unsigned int device_id, const void * data, unsigned int size, unsigned int * length_ptr, unsigned int flags, unsigned int timeout);
 
int SisoAuxPortReceive(SisoAuxPort handle, unsigned int device_id, void * data, unsigned int size, unsigned int * length_ptr, unsigned int flags, unsigned int timeout);
 
int SisoAuxPortTransmit(SisoAuxPort handle, unsigned int device_id, const void * data_out, unsigned int size_out, unsigned int * length_out_ptr, void * data_in, unsigned int size_in, unsigned int * length_in_ptr, unsigned int flags, unsigned int timeout);
 
 
#define SISO_AUX_PORT_SUCCESS                          0   
#define SISO_AUX_PORT_ERROR                          (-1)  
#define SISO_AUX_PORT_ERROR_INVALID_POINTER          (-2)  
#define SISO_AUX_PORT_ERROR_INVALID_SIZE             (-3)  
#define SISO_AUX_PORT_ERROR_INVALID_BOARD_ID         (-4)  
#define SISO_AUX_PORT_ERROR_INVALID_PORT_TYPE        (-5)  
#define SISO_AUX_PORT_ERROR_INVALID_PORT_NUMBER      (-6)  
#define SISO_AUX_PORT_ERROR_INVALID_PORT_HANDLE      (-7)  
#define SISO_AUX_PORT_ERROR_BUSY                     (-8)  
#define SISO_AUX_PORT_ERROR_OUT_OF_MEMORY            (-9)  
#define SISO_AUX_PORT_ERROR_PORT_NOT_OPEN           (-10)  
#define SISO_AUX_PORT_ERROR_OVERFLOW                (-11)  
#define SISO_AUX_PORT_ERROR_NOT_IMPLEMENTED         (-49)  
#define SISO_AUX_PORT_ERROR_INVALID_RWFLAGS         (-51)  
#define SISO_AUX_PORT_ERROR_IO_FAILURE              (-52)  
#define SISO_AUX_PORT_ERROR_TIMEOUT                 (-53)  
#define SISO_AUX_PORT_ERROR_INVALID_FLUSH_TYPE      (-54)  
#define SISO_AUX_PORT_ERROR_NO_DATA                 (-55)  
#define SISO_AUX_PORT_ERROR_INVALID_PROPERTY       (-101)  
#define SISO_AUX_PORT_ERROR_INVALID_PROPERTY_TYPE  (-102)  
#define SISO_AUX_PORT_ERROR_READ_ONLY_PROPERTY     (-103)  
#define SISO_AUX_PORT_ERROR_FREQUENCY_TOO_LOW      (-110)  
#define SISO_AUX_PORT_ERROR_FREQUENCY_TOO_HIGH     (-111)  
#define SISO_JTAG_PORT_ERROR                       (-200)  
#define SISO_JTAG_PORT_ERROR_INVALID_CHAIN         (-201)  
#define SISO_JTAG_PORT_ERROR_INVALID_IR_LENGTH     (-202)  
#define SISO_JTAG_PORT_ERROR_INVALID_DEVICE_ID     (-203)  
#define SISO_JTAG_PORT_ERROR_CHAIN_LENGTH_MISMATCH (-204)  
#define SISO_JTAG_PORT_ERROR_NO_CHAIN_SET          (-205)  
#define SISO_JTAG_PORT_ERROR_DATA_LENGTH_MISMATCH  (-206)  
#define SISO_I2C_PORT_ERROR_ARBITRATION_LOST       (-301)  
#define SISO_I2C_PORT_ERROR_ACK_NAK_MISMATCH       (-302)  
#define SISO_UIQ_PORT_ERROR_INVALID_TRANSMISSION_MODE   (-401)  
#define SISO_UIQ_PORT_ERROR_INVALID_SPI_MODE       (-402)  
 
 
#ifdef __cplusplus
}
#endif
 
#endif /* SISO_AUX_PORT_H */