2 - Advantech
Contents
1. u nar 28 3 3 7 SusiVgaSetBacklightLevel u a 28 NEE e EE e Et EE 29 33 9 SusIVgaSetPolanty EE 30 3 3 10 SusiVgaGetFrequency u 30 3 3 11 SUSIVGASCLFEQUCNCY EE 31 3 3 12 SusiVgaG elScreenEnabile AAA 31 3 3 13 SusiVgaSetSrceenEnable uuu 32 3 4 2G ren el 33 8 451 Susil2CGetCaps EE 33 3 42 Susil oCWriteReadCombine u a 34 BAD Ee RRE EE 35 3 44 Gusil cChritefransier u nunus 36 3 4 5 Gusil CProbeiievice AA 37 WEE EE EE 37 3 4 7 Susil2CSetFrequency nun 38 3 5 SMBUS FUNCTIONS Sa unas apen akten enka ean Sua aq a Sa asa 39 KADETTEN 39 3 52 SUuSISMBWMEBylG ebessen 40 8 5 3 SUSISMBReadWord TE 40 3 5 4 EE Oe DEE 41 3 5 5 SUsiSMBReceiveByte AA 42 3 5 6 GusiGMttGendfiwie AAA 43 3 5 7 SusiSMBReadQuick U L uuu 44 3 5 8 SusiISMBWFrIteQUIQK TT 44 3 5 9 SusiSMBReadBlo6k uy an Saa n r ane de bike rank oa ak ao 45 3 5 10 SUSISMBW ee 46 3 5 11 GuslGMDi2Cheadb iock uuu askha hasissu ashaka asap q asssashasaasaqsuyassaskispassskhas undskiuss 47 3 5 12 SUSISMBI2ZCWHitOBIOCK AA 48 3 6 WATCHDOG FUNCTIONS ene Geek Ge nie 50 KR NEE Re ET EE 51 386 2 SUSIWDogStart TE 52 3 6 3 SusSIWDogStop EE 53 3 6 4 SusiWDogTri2. Return Status Code Condition Return Value Library uninitialized SUSI STATUS NOT INITIALIZED Success SUSI STATUS SUCCESS 3 2 Information Functions 3 2 1 SusiBoardGetValue uint32 t SUSI API SusiBoardGetValue uint32_t Id uint32_t pValue Description Information about the hardware platform in value format Parameters Id Selects target value See Table 1 Table 5 pValue Pointer to a buffer that receives the value s data Return Status Code Condition Return Value SUSI_STATUS_NOT_INITIALIZED SUSI STATUS INVALID PARAMETER SUSI STATUS UNSUPPORTED SUSI STATUS UNSUPPORTED Library uninitialized pValue NULL Unknown Id Device unsupported Success SUSI STATUS SUCCESS Table 1 Board information value ID Id Description Unit SUSI ID GET SPEG VERSION SUSI ID BOARD BOOT COUNTER VAL SUSI ID BOARD RUNNING TIME METER VAL SUSI ID BOARD PNPID VAL SUSI ID BOARD PLATFORM REV VAL SUSI ID BOARD DRIVER VERSION VAL SUSI ID BOARD LIB VERSION VAL SUSI ID BOARD FIRMWARE VERSION VAL Table 2 Board voltage value ID Id API Specification Version Boot Counter 1 boot Running Time Meter 1 hour Board Vendor PNPID Platform revision Driver version Library version Firmware version Description Unit GE MMMM SUSI ID HWM VOLTAGE VCORE CPU Core voltage millivolts SUSI ID HWM VOLTAGE VCORE2 Second CPU Core voltage millivolts SUSI ID HWM VOLTAGE 2V5 2 5V millivolts SUSI ID HWM VOLTAGE 3V3 3 3V millivolts S
3. r d I y r SU r Coe SEOs AL SUSI 4 0 Secured amp Unified Smart Interface Software APIs Die EmbCore Edition 4 0 Part No 200EMBSA01 April 19 2013 Printed in Taiwan gt l Contents eeh KC 3 LIST OF TABLES uinteressert 6 1 INTRODUCTION u u u EES dee EE SEENEN EN 7 1 1 BENEFITS uden beid edda eae Gaal 7 1 2 ENVIRONMENT REQUIREMENTS Z una ukusaayastaqasqaqkanaqkukakaqakudhuspasnakanqaqaqhaka qaqay aata aa RAATS 8 1 21 Operating E 8 2 SUSIDEFINMTION I L nd aaa aa iaa a aaea Ea aE A E aa aaa a a aa aiaa 9 2 1 STATUS CODES uuu unu nie rappe ami aan era are as dn aa ia aaa 9 2 2 D EEE NE EE EE ERE ENER nts aus a aaa ana 13 2 3 MENDES 17 3 SUSIAPL Su cis caste a cece aa a aa amuyu uhaspa asnu aaa 19 3 1 INITIALIZATION FUNCTIONS za n n ananassa naa aqa a ae aa aasan siasa 19 E We 19 E CN 19 3 2 INFORMATION We el EE 21 KEN NEE Eeler 21 3 22 SusIiBoardGelSIrmgA AAA 23 3 3 BACKLIGHT FUNGTIONS EE 25 KREE e EE 25 3 3 2 SusiVgaGetBacklightEnable u na 26 3 3 3 SusiVgaSetBacklightEnable L n n nn 26 3 3 4 SusiVgaGetBacklightBrightness u n naa 27 3 3 5 SusiVgaSetBacklightBrightness u L nn 27 3 3 6 sSusiVgaGelItBacklightLevel
4. SUSI ID STORAGE PSW MAX LEN Table 27 Storage Lock Status Lock Status SUSI STORAGE STATUS LOCK SUSI STORAGE STATUS UNLOCK 3 9 2 SusiStorageAreaRead Get maximum length in byte of storage lock key Description Storage is lock Storage is unlock uint32 t SUSI API SusiStorageAreaRead uint32_t Id uint32 t Offset uint8_t pBuffer uint32 t Butt en Description Reads data from the selected user data area Parameters Id Selects target device See Table 25 Offset Storage area start address offset in bytes pBuffer Size in bytes of the buffer pointed to by the pBuffer parameter BufLen Size in bytes of the information read to the buffer pointed to by the pBuffer parameter Return Status Code Condition Library uninitialized pBuffer NULL BufLen 0 Offset BufLen gt TotalSize Unknown Id Read error Success 3 9 3 SusiStorageAreaWrite Return Value SUSI STATUS NOT INITIALIZED SUSI STATUS INVALID PARAMETER SUSI STATUS INVALID BLOCK LENGTH SUSI STATUS UNSUPPORTED SUSI STATUS READ ERROR SUSI STATUS SUCCESS uint32 t SUSI API SusiStorageAreaWrite uint32_t Id uint32 t Offset uint8 t pBuffer uint32 t Butt en Et Description Writes data to the selected user data area Parameters Id Selects target device See Table 25 Offset Storage area start address offset in bytes pBuffer Size in bytes of the buffer pointed to by the pBuffer parameter BufLen Size in bytes of the info
5. Condition Return Value Library uninitialized SUSI STATUS NOT INITIALIZED pValue NULL SUSI STATUS INVALID PARAMETER Unknown Id SUSI STATUS UNSUPPORTED Success SUSI STATUS SUCCESS Table 21 GPIO capabilities item Id Item Id Description SUSI ID GPIO INPUT SUPPORT Get GPIO input support state SUSI ID GPIO OUTPUT SUPPORT Get GPIO output support state 3 7 2 SusiGPIOGetDirection uint32_t SUSI API SusiGPlOGetDirection uint32_t Id uint32 t Bitmask uint32_t pDirection Description Reads the capabilities of the current GPIO implementation from the selected GPIO interface Parameters Id Selects target device See Table 20 Bitmask Value for a bit mask Only selected bits are changed unselected bits remain unchanged This parameter will be ignored when single pin mode pDirection Pointer to a buffer that receives the direction of the selected GPIO ports Return Status Code Condition Return Value Library uninitialized SUSI STATUS NOT INITIALIZED pDirection NULL SUSI STATUS INVALID PARAMETER Bitmask 0 when bank mode SUSI STATUS INVALID PARAMETER Unknown Id SUSI STATUS UNSUPPORTED Success SUSI STATUS SUCCESS 3 7 3 SusiGPIOSetDirection uint32 t SUSI API SusiGPIOSetDirection uint32 tld uint32 t Bitmask uint32 t Direction Description Sets the configuration for the selected GPIO ports Parameters Id Selects target device See Table 20 Bitmask Value for a bit mask Only selected bits are changed uns
6. Id Selects target device See Table 16 Addr Specifies the 8 bit device address ranging from 0x00 to OxFF Whether to give a 1 read or 0 write to the LSB of slave address could be ignored Cmd Specifies the offset or command of the device register to read data from pBuffer Pointer to a variable in which the function reads the word data Return Status Code Condition Return Value Library uninitialized SUSI STATUS NOT INITIALIZED pBuffer NULL SUSI STATUS INVALID PARAMETER Unknown Id SUSI STATUS UNSUPPORTED Bus Busy SDA SDC low SUSI STATUS BUSY COLLISION Arbitration Error Collision Error On Write 1 write cycle SUSI STATUS BUSY COLLISION SDA Remains low Time out due to clock stretching SUSI STATUS TIMEOUT Address Non ACK SUSI STATUS NOT FOUND Write Non ACK SUSI STATUS WRITE ERROR Success SUSI STATUS SUCCESS 3 5 4 SusiSMBWriteWord uint32 t SUSI API SusiSMBWriteWord uint32_t Id uint8_t Addr uint8 t Cmd uint16 t Data Description Write a word of data to the target slave device in the SMBus Parameters KE Id Selects target device See Table 16 Addr Specifies the 8 bit device address ranging from 0x00 to OxFF Whether to give a 1 read or 0 write to the LSB of slave address could be ignored Cmd Specifies the offset or command of the device register to write data to Data Specifies the word data to be written Return Status Code Condition Return Value Library uninitialized SUSI STATUS NOT INITIA
7. SUSI WDT INT CALLBACK pfnCallback void Context Description The call back function pointer can be transmit from the application when IRQ triggered Parameters Id Selects target device See Table 17 pfnCallback Call back function pointer SUSI WDT INT CALLBACK is function pointer type it can set NULL to clear The type definition is shown below typedef void SUSI WDT INT CALLBAGKY void Context Pointer to a user context structure for callback function Return Status Code Condition Return Value Library uninitialized SUSI STATUS NOT INITIALIZED Unknown Id SUSI STATUS UNSUPPORTED Success SUSI STATUS SUCCESS 3 7 GPIO Functions Programmable GPIO allows developers to dynamically set the GPIO input or output status Table 20 GPIO ID Id Description X is GPIO pin number definition as below SUSI ID GPIO X define SUSI ID GPIO x 0x0000 x This ID control single pin only Y is GPIO bank number definition as below SUSI ID GPIO BANK Y define SUSI ID GPIO BANK Y 0x10000 Y This ID control maximum 32 pins per bank 3 7 1 SusiGPIOGetCaps uint32 t SUSI API SusiGPlOGetCaps uint32_t Id uint32 t Itemid uint82_t pValue Description Reads the capabilities of the current GPIO implementation from the selected GPIO interface Parameters Id Selects target device See Table 20 Itemid Selects target capability See Table 21 pValue Pointer to a buffer that receives the target capability Return Status Code
8. Call SusiLiblnitialize define SUSI STATUS INITIALIZED 0O0xFFFFFFFE Description Library is initialized Actions none define SUSI STATUS ALLOC ERROR OxFFFFFFFD Description Memory Allocation Error Actions Free memory and try again define SUSI STATUS DRIVER TIMEOUT OxFFFFFFFC Description Time out in driver This is Normally caused by hardware software semaphore timeout Actions Retry define SUSI STATUS INVALID PARAMETER OxFFFFFEFF Description One or more of the SUSI API function call parameters are out of the defined range So oe63 lt e_ _ me __ Actions Verify Function Parameters define SUSI STATUS INVALID BLOCK ALIGNMENT OxFFFFFEFE Description The Block Alignment is incorrect Actions Use Inputs and Outputs to correctly select input and outputs define SUSI STATUS INVALID BLOCK LENGTH OxFFFFFEFD Description This means that the Block length is too long Actions Use Alignment Capabilities information to correctly align write access define SUSI STATUS INVALID DIRECTION OxFFFFFEFC Description The current Direction Argument attempts to set GPIOs to a unsupported directions LE Setting GPI to Output Actions Use Inputs and Outputs to correctly select input and outputs define SUSI STATUS INVALID BITMASK OxFFFFFEFB Description The Bitmask Selects bits GPIOs which are not supported for the current ID Actions Use Inputs and Outputs to probe supported bits define SUSI STATUS RUN
9. Return Status Code Condition Library uninitialized Level gt SUSI BACKLIGHT LEVEL MAXIMUM Unknown Id Device unsupported Success SusiVgaGetPolarity Return Value SUSI STATUS NOT INITIALIZED SUSI STATUS INVALID PARAMETER SUSI STATUS UNSUPPORTED SUSI STATUS UNSUPPORTED SUSI STATUS SUCCESS uint32 t SUSI API SusiVgaGetPolarity uint32_t Id uint82_t pPolarity Description Reads the current backlight polarity of the selected flat panel display Parameters Id Selects target device See Table 7 pPolarity Pointer to a buffer that receives the current backlight polarity See Table 11 Return Status Code Condition Library uninitialized pPolarity NULL Unknown Id Success Return Value SUSI STATUS NOT INITIALIZED SUSI STATUS INVALID PARAMETER SUSI STATUS UNSUPPORTED SUSI STATUS SUCCESS Et Table 11 Brightness polarity definition Name Description SUSI BACKLIGHT POLARITY ON Backlight signal polarity ON SUSI BACKLIGHT POLARITY OFF Backlight signal polarity OFF 3 3 9 SusiVgaSetPolarity uint32 t SUSI API SusiVgaSetPolarity uint32 Id uint32 t Polarity Description Sets the polarity of the selected flat panel display Parameters Id Selects target device See Table 7 Polarity Polarity state See Table 11 Return Status Code Condition Return Value Library uninitialized SUSI STATUS NOT INITIALIZED Unknown Id SUSI STATUS UNSUPPORTED Success SUSI STATUS SUCCESS 3 3 10SusiVgaGetFrequency
10. Address Non ACK SUSI STATUS NOT FOUND Success SUSI STATUS SUCCESS 3 5 8 SusiSMBWriteQuick uint32 t SUSI API SusiSMBWriteQuick uint32 t Id uint8_t Addr Description Turn SMBus device function off on or disable enable a specific device mode Parameters no lu Id Selects target device See Table 16 Addr Specifies the 8 bit device address ranging from 0x00 to OxFF Whether to give a 1 read or 0 write to the LSB of slave address could be ignored Return Status Code Condition Return Value Library uninitialized SUSI STATUS NOT INITIALIZED Unknown Id SUSI STATUS UNSUPPORTED Bus Busy SDA SDC low SUSI STATUS BUSY COLLISION Arbitration Error Collision Error On Write 1 write cycle SUSI STATUS BUSY COLLISION SDA Remains low Time out due to clock stretching SUSI STATUS TIMEOUT Address Non ACK SUSI STATUS NOT FOUND Success SUSI STATUS SUCCESS 3 5 9 SusiSMBReadBlock uint32_t SUSI API SusiSMBReadBlock uint32_t Id uint8_t Addr uint8_t Cmd uint8_t pBuffer uint32_t pLength Description Read multi data from the target slave device in the SMBus Parameters Id Selects target device See Table 16 Addr Specifies the 8 bit device address ranging from 0x00 to OxFF Whether to give a 1 read or 0 write to the LSB of slave address could be ignored Cmd Specifies the offset or command of the device register to read data from pBuffer Pointer to a byte array in which the function reads the block data pLength
11. HWM VOLTAGE 2V5 0x00021002 define SUSI ID HWM VOLTAGE 3V3 0x00021003 define SUSI ID HWM VOLTAGE 5V 0x00021004 define SUSI ID HWM VOLTAGE 12V 0x00021005 define SUSI ID HWM VOLTAGE 5VSB 0x00021006 define SUSI ID HWM VOLTAGE 3VSB 0x00021007 define SUSI ID HWM VOLTAGE VBAT 0x00021008 define SUSI ID HWM VOLTAGE 5NV 0x00021009 define SUSI ID HWM VOLTAGE 12NV 0x0002100A define SUSI ID HWM VOLTAGE VTT 0x0002100B define SUSI ID HWM VOLTAGE 24V 0x0002100C define SUSI ID HWM VOLTAGE OEMO 0x00021010 define SUSI ID HWM VOLTAGE OEM1 0x00021011 define SUSI ID HWM VOLTAGE OEM2 0x00021012 define SUSI ID HWM VOLTAGE OEM3 0x00021013 Description Board voltage value ID use in SusiBoardGetValue define SUSI ID HWM FAN CPU 0x00022000 define SUSI ID HWM FAN SYSTEM 0x00022001 define SUSI ID HWM FAN CPU2 0x00022002 define SUSI ID HWM FAN OEMO 0x00022003 define SUSI ID HWM FAN OEM1 0x00022004 define SUSI ID HWM FAN OEM2 0x00022005 define SUSI ID HWM FAN OEM3 0x00022006 define SUSI ID HWM FAN OEM4 0x00022007 define SUSI ID HWM FAN OEM5 0x00022008 define SUSI ID HWM FAN OEMS6 0x00022009 Description Board fan speed value ID use in SusiBoardGetValue and Smart Fan Functions define SUSI ID HWM CURRENT OEMO 0x00023000 define SUSI ID HWM CURRENT OEM1 0x00023001 define SUSI ID HWM CURRENT OEM2 0x00023002 Description Board current value ID use in SusiBoardGetValue L EE define SUSI ID SMBUS SUPPORTED 0
12. Pointer to a byte in which specifies the number of bytes to be read and also return succeed bytes er Return Status Code Condition Return Value Library uninitialized SUSI STATUS NOT INITIALIZED pBuffer NULL SUSI STATUS INVALID PARAMETER Unknown Id SUSI STATUS UNSUPPORTED Bus Busy SDA SDC low SUSI STATUS BUSY COLLISION Arbitration Error Collision Error On Write 1 write cycle SUSI STATUS BUSY COLLISION SDA Remains low Time out due to clock stretching SUSI STATUS TIMEOUT Address Non ACK SUSI STATUS NOT FOUND Write Non ACK SUSI STATUS WRITE ERROR Success SUSI STATUS SUCCESS 3 5 10SusiSMBWriteBlock uint32 t SUSI API SusiSMBWriteBlock uint32_t Id uint8_t Addr uint8 t Cmd uint8_t pBuffer uint32 t Length Description Write multi data from the target slave device in the SMBus Parameters Id Selects target device See Table 16 Addr Specifies the 8 bit device address ranging from 0x00 to OxFF Whether to give a 1 read or 0 write to the LSB of slave address could be ignored Cmd Specifies the offset or command of the device register to write data to pBuffer Pointer to a byte array in which the function writes the block data Length Specifies the number of bytes to be write Return Status Code Condition Return Value ar ll Library uninitialized SUSI STATUS NOT INITIALIZED pBuffer NULL SUSI STATUS INVALID PARAMETER Unknown Id SUSI STATUS UNSUPPORTED Bus Busy SDA SDC low SUSI STATUS BUSY COLLISION Arbitrati
13. Supports throttle event 0x02 SUSI_THERMAL_FLAG_SUPPORT_POWEROFF Supports power off event 0x04 3 10 2SusiThermalProtectionSetConfig uint32 t SUSI API SusiThermalProtectionSetConfig uint32_t Id SusiThermalProtect pConfig Description Set Thermal Protection configuration Parameters Id Selects target device See Table 29 pConfig A data package for thermal protection Return Status Code Condition Return Value Library uninitialized SUSI STATUS NOT INITIALIZED pConfig NULL SUSI STATUS INVALID PARAMETER Config invalid SUSI STATUS INVALID PARAMETER Source Id or event type not supported SUSI STATUS UNSUPPORTED Unknown Id SUSI STATUS UNSUPPORTED Success SUSI STATUS SUCCESS 3 10 3SusiThermalProtectionGetConfig uint32 t SUSI API SusiThermalProtectionGetConfig uint32_t Id SusiThermalProtect pConfig Description Get Thermal Protection configuration Parameters Id Selects target device See Table 29 pConfig A data package for thermal protection Return Status Code T Condition Return Value Library uninitialized SUSI STATUS NOT INITIALIZED pConfig NULL SUSI STATUS INVALID PARAMETER Unknown Id SUSI STATUS UNSUPPORTED Success SUSI STATUS SUCCESS
14. bits are changed unselected bits remain unchanged This parameter will be ignored when single pin mode Level Input level of the selected GPIO port Return Status Code Condition Return Value Library uninitialized SUSI STATUS NOT INITIALIZED Bitmask 0 when bank mode SUSI STATUS INVALID PARAMETER Unknown Id SUSI STATUS UNSUPPORTED Success SUSI STATUS SUCCESS 3 8 Smart Fan Functions The Smart Fan function call is used to set fan speed configuration You can use this function to easily control the fan speed It takes a pointer to an instance of structure SusiFanControl which is defined as follows define SUSI_FAN_AUTO_CTRL_OPMODE_PWM 0 define SUSI_FAN_AUTO_CTRL_OPMODE_RPM 1 typedef struct _AutoFan uint32 t TmlSource Thermal source uint32 t OpMode uint32 t LowStopLimit Temperature 0 1 Kelvins uint32 t LowLimit Temperature 0 1 Kelvins uint32 t HighLimit Temperature 0 1 Kelvins uint32 t MinPWM Enable when OpMode FAN AUTO CTRL OPMODE PWM uint32 t MaxPWM Enable when OpMode FAN AUTO CTRL OPMODE D uint32 t MinRPM Enable when OpMode FAN AUTO CTRL OPMODE RPM uint32 t MaxRPM Enable when OpMode FAN AUTO CTRL OPMODE RPM AutoFan PAutoFan Mode define SUSI_FAN_CTRL_MODE_OFF 0 define SUSI FAN CTRL MODE FULL define SUSI FAN CTRL MODE MANUAL 2 define SUSI FAN CTRL MODE AUTO 3 typedef struct SusiFanControl uint32 t Size
15. uint32 t Mode uint32 t PWM Manual mode only 0 100 AutoFan AutoCont rol Auto mode only SusiFanControl PSusiFanCont rol If Mode member of SusiFanControl is not Auto AutoControl member will be ignored In auto mode parameter TmlSource is use SUS ID HWM TEMP XXX Table 3 to select which thermal type to reference If TmlSource does not match any temperature ID it means it is unknown or unsupported 3 8 1 SusiFanControlGetCaps uint32 t SUSI API SusiFanControlGetCaps uint32_t Id uint32 t Itemid uint82_t pValue Description Gets fan control capabilities Parameters Id Smart fan ID is same as Fan Speed Value ID See Table 4 Itemid Selects target capability See Table 22 This parameter can also input temperature ID Table 3 to get is it supports in SusiFanControl function pValue Pointer to a buffer that receives the target capability Return Status Code Condition Return Value Library uninitialized SUSI_STATUS_NOT_INITIALIZED pValue NULL SUSI _STATUS_INVALID_PARAMETER Unknown Id or Itemld SUSI _STATUS_UNSUPPORTED Success SUSI STATUS SUCCESS Table 22 Fan control capabilities item Id Item Id Description SUSI ID FC CONTROL SUPPORT FLAGS Control support flags See Table 23 SUSI ID FC AUTO SUPPORT FLAGS Auto support flags See Table 24 Table 23 Control Support Flags Flag Name Description Value SUSI FC FLAG SUPPORT OFF MODE Support off mode 0x01 SUSI_FC_FLAG_SU
16. uint32 t SUSI API SusiVgaGetFrequency uint32_t Id uint82_t pFrequency Description Reads the current backlight frequency of the selected flat panel display Parameters Id Selects target device See Table 7 pFrequency Pointer to a buffer that receives the current backlight frequency Unit Hz Return Status Code Condition Return Value SO SUSI STATUS NOT INITIALIZED Library uninitialized pFrequency NULL Unknown Id Device unsupported Success SUSI STATUS INVALID PARAMETER SUSI STATUS UNSUPPORTED SUSI STATUS UNSUPPORTED SUSI STATUS SUCCESS 3 3 11SusiVgaSetFrequency uint32 t SUSI API SusiVgaSetFrequency uint32_t Id uint32 t Frequency Description Sets the frequency of the selected flat panel display Parameters Id Selects target device See Table 7 Polarity Frequency value Unit Hz Return Status Code Condition Return Value SUSI STATUS NOT INITIALIZED Library uninitialized Unknown Id Device unsupported Success SUSI STATUS UNSUPPORTED SUSI STATUS UNSUPPORTED SUSI STATUS SUCCESS 3 3 12SusiVgaGetScreenEnable uint32 t SUSI API SusiVgaGetScreenEnable uint32_t Id uint32 t pEnable Description Reads the current screen status of the selected device Parameters Id Selects target device pEnable Pointer to a buffer that receives the current screen state See Table 12 r Return Status Code Condition Library uninitialized pEna
17. AGS 0x00000000 define SUSI ID TP EVENT TRIGGER MAXIMUM 0x00000001 define SUSI ID TP EVENT TRIGGER MINIMUM 0x00000002 define SUSI ID TP EVENT CLEAR MAXIMUM 0x00000003 define SUSI ID TP EVENT CLEAR MINIMUM 0x00000004 Description Thermal protection capabilities item ID use in SusiThermalProtectionGetCaps 3 3 SUSI API The SUSI API provides the functions to control ADVANTECH platforms SUSI API functions are based on a dynamic library SUSI API can be implemented in various other programming languages 3 1 Initialization Functions 3 1 1 SusiLiblnitialize uint32 t SUSI API SusiLiblnitialize void Description General initialization of the SUSI API Prior to calling any SUSI API function the library needs to be initialized by calling this function The status code for all SUSI API function will be SUSI STATUS NOT INITIALIZED unless this function is called Parameters None Return Status Code Condition Return Value Library initialized SUSI STATUS INITIALIZED Library initial fail SUSI STATUS NOT INITIALIZED Success SUSI STATUS SUCCESS 3 1 2 SusiLibUninitialize uint32 1 SUSI API SusiLibUninitialize void Description General function to uninitialized the SUSI API library that should be called before program exit In a dynamic library environment this function is not expected to replace the native uninitialized routines It is expected that in this environments this function has no functionality Parameters None
18. ALID PARAMETER Unknown Id SUSI STATUS UNSUPPORTED Device unsupported SUSI STATUS UNSUPPORTED Success SUSI STATUS SUCCESS 3 3 3 SusiVgaSetBacklightEnable uint32 t SUSI API SusiVgaSetBacklightEnable uint32_t Id uint32 t Enable Description Enables or disable the backlight of the selected flat panel display Parameters Id Selects target device See Table 7 Enable Backlight Enable options See Table 8 Et Return Status Code Condition Return Value Library uninitialized SUSI STATUS NOT INITIALIZED Unknown Id SUSI STATUS UNSUPPORTED Device unsupported SUSI STATUS UNSUPPORTED Success SUSI STATUS SUCCESS 3 3 4 SusiVgaGetBacklightBrightness uint32 t SUSI API SusiVgaGetBacklightBrightness uint32_t Id uint32 t pBright Description Reads the current brightness of the selected flat panel display Parameters Id Selects target device See Table 7 pBright Pointer to a buffer that receives the current backlight brightness value Return Status Code Condition Return Value Library uninitialized SUSI STATUS NOT INITIALIZED pBright NULL SUSI STATUS INVALID PARAMETER Unknown Id SUSI STATUS UNSUPPORTED Device unsupported SUSI STATUS UNSUPPORTED Success SUSI STATUS SUCCESS 3 3 5 SusiVgaSetBacklightBrightness uint32 t SUSI API SusiVgaSetBacklightBrightness uint32_t Id uint32 t Bright Description Reads the current brightness of the selected flat panel display Parameters Id Selects target device See Table 7 Brig
19. ATUS TIMEOUT Address Non ACK SUSI STATUS NOT FOUND Write Non ACK SUSI STATUS WRITE ERROR Success SUSI STATUS SUCCESS 3 4 5 Susil2CProbeDevice uint32 t SUSI API Susil2CProbeDevice uint32 Id uint32 t Addr Description Probes IC address to test IC device present Parameters Id Selects target device See Table 15 Addr Encoded 7 10 Bit IC Device Address Return Status Code Condition Return Value Library uninitialized SUSI STATUS NOT INITIALIZED Unknown Id SUSI STATUS UNSUPPORTED Bus Busy SDA SDC low SUSI STATUS BUSY COLLISION Arbitration Error Collision Error On Write 1 write cycle SUSI STATUS BUSY COLLISION SDA Remains low Time out due to clock stretching SUSI STATUS TIMEOUT Address Non ACK SUSI STATUS NOT FOUND Write Non ACK SUSI STATUS WRITE ERROR Success SUSI STATUS SUCCESS 3 4 6 Susil2CGetFrequency uint32 t SUSI API Susil2CGetFrequency uint32_t Id uint32_t pFreq Description e 3 4 7 Get DC clock frequency Parameters Id Selects target device See Table 15 pFreq Pointer to a buffer that receives the C clock frequency value Unit Hz Return Status Code Condition Library uninitialized Unknown Id Device unsupported pFreq NULL Success Susil2CSetFrequency Return Value SUSI STATUS NOT INITIALIZED SUSI STATUS UNSUPPORTED SUSI STATUS UNSUPPORTED SUSI STATUS INVALID PARAMETER SUSI STATUS SUCCESS uint32 t SUSI API Susil2CSetFrequency uint32_t Id uint32 t Freq Desc
20. E ERROR Success SUSI STATUS SUCCESS 3 5 12SusiSMBI2CWriteBlock uint32 t SUSI API SusiSMBI2CWriteBlock uint32 t Id uint8 t Addr uint8_t Cmd uint8_t pBuffer uint32 t Length Description Write multi data using I C block protocol from the target slave device in the SMBus Parameters Id Selects target device See Table 16 Addr Specifies the 8 bit device address ranging from 0x00 to OxFF Whether to give a 1 read or 0 write to the LSB of slave address could be ignored Cmd Specifies the offset or command of the device register to write data to pBuffer Pointer to a byte array in which the function writes the block data Length Specifies the number of bytes to be write Return Status Code Condition Return Value Library uninitialized SUSI STATUS NOT INITIALIZED pBuffer NULL SUSI STATUS INVALID PARAMETER Unknown Id SUSI STATUS UNSUPPORTED Device unsupported SUSI STATUS UNSUPPORTED lt 3 Bus Busy SDA SDC low SUSI STATUS BUSY COLLISION Arbitration Error Collision Error On Write 1 write cycle SUSI STATUS BUSY COLLISION SDA Remains low Time out due to clock stretching SUSI STATUS TIMEOUT Address Non ACK SUSI STATUS NOT FOUND Write Non ACK SUSI STATUS WRITE ERROR Success SUSI STATUS SUCCESS 3 6 Watchdog Functions After the watchdog timer has started it must be triggered within the Delay Event Timeout millisecond parameters as set in the start function Following the initial trigger every subsequent trigger
21. Error Collision Error On Write 1 write cycle SDA Remains low Time out due to clock stretching Address Non ACK Write Non ACK Success 3 4 4 Susil2CWriteTransfer SUSI STATUS BUSY COLLISION SUSI STATUS TIMEOUT SUSI STATUS NOT FOUND SUSI STATUS WRITE ERROR SUSI STATUS SUCCESS uint32 t SUSI API Susil2CWriteTransfer uint32_t Id uint32 t Addr uint32 t Cmd uint8_t pBuffer uint32 t ByteCnt Description Write to a specific register in the selected DC device Writes to an TC device at the IC address Addr the amount of ByteCnt bytes from the buffer pBuffer while using the device specific command Cmd Depending on the addressed I C device Cmd can be a specific command or a byte offset Parameters Id Selects target device See Table 15 Addr Encoded 7 10 Bit IC Device Address Cmd Encoded DC Device Command Index See Table 14 pBuffer Pointer to a buffer that receives the write data ByteCnt Size in bytes of the buffer pointed to by the pBuffer parameter Return Status Code Condition Library uninitialized pBuffer NULL ByteCnt 0 ByteCnt gt MaxLength Unknown Id Bus Busy SDA SDC low Return Value SUSI STATUS NOT INITIALIZED SUSI STATUS INVALID PARAMETER SUSI STATUS INVALID BLOCK LENGTH SUSI STATUS UNSUPPORTED SUSI STATUS BUSY COLLISION Arbitration Error Collision Error On Write 1 write cycle SUSI STATUS BUSY COLLISION SDA Remains low Time out due to clock stretching SUSI ST
22. ISION Arbitration Error Collision Error On Write 1 write cycle SUSI STATUS BUSY COLLISION SDA Remains low Time out due to clock stretching SUSI STATUS TIMEOUT Address Non ACK SUSI STATUS NOT FOUND Write Non ACK SUSI STATUS WRITE ERROR Success SUSI STATUS SUCCESS 3 5 2 SusiSMBWriteByte uint32 t SUSI API SusiSMBWriteByte uint32 t Id uint8 t Addr uint8 t Cmd uint8_t Data Description Write a byte of data to the target slave device in the SMBus Parameters Id Selects target device See Table 16 Addr Specifies the 8 bit device address ranging from 0x00 to OxFF Whether to give a 1 read or 0 write to the LSB of slave address could be ignored Cmd Specifies the offset or command of the device register to write data to Data Specifies the byte data to be written Return Status Code Condition Return Value Library uninitialized SUSI_STATUS_NOT_INITIALIZED Unknown Id SUSI STATUS UNSUPPORTED Bus Busy SDA SDC low SUSI STATUS BUSY COLLISION Arbitration Error Collision Error On Write 1 write cycle SUSI STATUS BUSY COLLISION SDA Remains low Time out due to clock stretching SUSI STATUS TIMEOUT Address Non ACK SUSI STATUS NOT FOUND Write Non ACK SUSI STATUS WRITE ERROR Success SUSI STATUS SUCCESS 3 5 3 SusiSMBReadWord uint32 t SUSI API SusiSMBReadWord uint32_t Id uint8 t Addr uint8 t Cmd uint16 ar pBuffer Description Read a word of data from the target slave device in the SMBus Parameters
23. Implementation Efficiency When developers want to write an application that involves hardware access they have to study the specifications to write the drivers This is a time consuming job and requires lots of expertise Advantech has done all the hard work for our customers with the release of a suite of Software APIs Application Programming Interfaces called Secured amp Unified Smart Interface SUSI SUSI provides not only the underlying drivers required but also a rich set of user friendly intelligent and integrated interfaces which speeds development enhances security and offers add on value for Advantech platforms SUSI plays the role of catalyst between developer and solution and makes Advantech embedded platforms easier and simpler to adopt and operate with customer applications 1 1 Benefits v Faster Time to Market SUSI s unified API helps developers write applications to control the hardware without knowing the hardware specs of the chipsets and driver architecture v Reduced Project Effort When customers have their own devices connected to the onboard bus they can either study the data sheet and write the driver amp API from scratch or they can use SUSI to start the integration with a 50 head start Developers can reference the sample program on the CD to see and learn more about the software development environment v Enhances Hardware Platform Reliability SUSI provides a trusted custom ready solution which comb
24. LIZED Unknown Id SUSI STATUS UNSUPPORTED Bus Busy SDA SDC low SUSI STATUS BUSY COLLISION Arbitration Error Collision Error On Write 1 write cycle SUSI STATUS BUSY COLLISION SDA Remains low Time out due to clock stretching SUSI STATUS TIMEOUT Address Non ACK SUSI STATUS NOT FOUND Write Non ACK SUSI STATUS WRITE ERROR Success SUSI STATUS SUCCESS 3 5 5 SusiSMBReceiveByte uint32 t SUSI API SusiSMBReceiveByte uint32_t Id uint8_t Addr uint8_t pBuffer Description Receive a byte of data from the target slave device in the SMBus Parameters Id Selects target device See Table 16 Addr Specifies the 8 bit device address ranging from 0x00 to OxFF Whether to give a 1 read or 0 write to the LSB of slave address could be ignored pBuffer Pointer to a variable in which the function receive the byte data Et Return Status Code Condition Return Value Library uninitialized SUSI STATUS NOT INITIALIZED pBuffer NULL SUSI STATUS INVALID PARAMETER Unknown Id SUSI STATUS UNSUPPORTED Bus Busy SDA SDC low SUSI STATUS BUSY COLLISION Arbitration Error Collision Error On Write 1 write cycle SUSI STATUS BUSY COLLISION SDA Remains low Time out due to clock stretching SUSI STATUS TIMEOUT Address Non ACK SUSI STATUS NOT FOUND Write Non ACK SUSI STATUS WRITE ERROR Success SUSI STATUS SUCCESS 3 5 6 SusiSMBSendByte uint32_t SUSI API SusiSMBSendByte uint32_t Id uint8_t Addr uint8_t Cmd uint8_t Data Description Send a byte of data to the
25. MANUFACTURER STR define SUSI ID BOARD NAME STR define SUSI ID BOARD REVISION STR define SUSI ID BOARD SERIAL STR define SUSI ID BOARD BIOG REVISION STR define SUSI ID BOARD HW REVISION STR define SUSI ID BOARD PLATFORM TYPE STR Description Board information string ID use in SusiBoardGetStringA define SUSI ID GET SPEC VERSION define SUSI ID BOARD BOOT COUNTER VAL define SUSI ID BOARD RUNNING TIME METER VAL define SUSI ID BOARD PNPID VAL define SUSI ID BOARD PLATFORM REV VAL define SUSI ID BOARD DRIVER VERSION VAL define SUSI ID BOARD LIB VERSION VAL define SUSI ID BOARD FIRMWARE VERSION VAL Description Board information value ID use in SusiBoardGet Value define SUSI define SUSI define SUSI define SUSI define SUSI define SUSI define SUSI define SUSI define SUSI define SUSI Description D HWM TEMP CPU D HWM TEMP CHIPSET D HWM TEMP SYSTEM D HWM TEMP CPU2 D HWM TEMP OEMO D HWM TEMP OEM1 D HWM TEMP OEM2 D HWM TEMP OEM3 D HWM TEMP OEM4 D HWM TEMP OEM5 Board temperature value ID use in SusiBoardGetValue OxFFFFFFFF O O A OO N CH 0x00000000 0x00000001 0x00000002 0x00000003 0x00000004 0x00010000 0x00010001 0x00010002 0x00020000 0x00020001 0x00020002 0x00020003 0x00020004 0x00020005 0x00020006 0x00020007 0x00020008 0x00020009 define SUSI ID HWM VOLTAGE VCORE 0x00021000 define SUSI ID HWM VOLTAGE VCORE2 0x00021001 define SUSI ID
26. NING OxFFFFFEFA Description Watchdog timer already started Actions Call SusiWDogStop before retrying define SUSI STATUS UNSUPPORTED OxFFFFFCFF Description This function or ID is not supported at the actual hardware environment Actions none et define SUSI STATUS NOT FOUND OxFFFFFBFF Description Selected device was not found Actions none define SUSI STATUS TIMEOUT OxFFFFFBFE Description Device has no response Actions none define SUSI STATUS BUSY COLLISION OxFFFFFBFD Description The selected device or ID is busy or a data collision was detected Actions Retry define SUSI STATUS READ ERROR OxFFFFFAFF Description An error was detected during a read operation Actions Retry define SUSI STATUS WRITE ERROR OxFFFFFAFE Description An error was detected during a write operation Actions Retry define SUSI STATUS MORE DATA OxFFFFFOFF Description The amount of available data exceeds the buffer size Storage buffer overflow was prevented Read count was larger than the defined buffer length Actions Either increase the buffer size or reduce the block length define SUSI STATUS ERROR OxFFFFFOFF Description e EE Generic error message No further error details are available Actions none define SUSI STATUS SUCCESS 0 Description The operation was successful Actions none 2 2 ern ID define SUSI ID UNKNOWN Description Undefined Unknown ID define SUSI ID BOARD
27. PPORT_FULL_MODE Support full mode 0x02 SUSI_FC_FLAG_SUPPORT_MANUAL_MODE Support manual mode 0x04 SUSI_FC_FLAG_SUPPORT_AUTO_MODE ee 0x08 More detail to get Auto Support Flags Table 24 Auto Support Flags Flag Name Description Value SUSI FC FLAG SUPPORT AUTO LOW STOP Auto mode support Low Stop 0x01 SUSI FC FLAG SUPPORT AUTO LOW LIMIT Auto mode support Low Limit 0x02 SUSI FC FLAG SUPPORT AUTO HIGH LIMIT Auto mode support High Limit 0x04 SUSI FC FLAG SUPPORT AUTO PWM Auto mode support PWM operation 0x0100 SUSI FC FLAG SUPPORT AUTO RPM Auto mode support RPM operation 0x0200 3 8 2 SusiFanControlGetConfig uint32 t SUSI API SusiFanControlGetConfig uint32 tld SusiFanControl pConfig Description Get information about smart fan function mode and configuration Parameters Id Smart fan ID is same as Fan Speed Value ID See Table 4 pConfig Pointer to the smart fan function configuration Return Status Code Condition Return Value Library uninitialized SUSI STATUS NOT INITIALIZED pConfig NULL SUSI STATUS INVALID PARAMETER Unknown Id SUSI STATUS UNSUPPORTED Device does not support smart mode SUSI STATUS UNSUPPORTED Success SUSI STATUS SUCCESS 3 8 3 SusiFanControlSetConfig uint32 t SUSI API SusiFanControlSetConfig uint32 tld SusiFanControl pConfig Description Sets smart fan function mode and configuration Parameters Id Smart fan ID is same as Fan Speed Value ID See Table 4 pConfig Pointer to the smart fan fun
28. THERMAL_PROTECT_3 Thermal protection zone 1 Thermal protection zone 2 Thermal protection zone 3 SUSI_ID_THERMAL_PROTECT_4 Thermal protection zone 4 3 10 1SusiThermalProtectionGetCaps uint32 t SUSI API SusiThermalProtectionGetCaps uint32 t Id uint82_t Itemid uint32_t pValue Description Gets Thermal Protection capabilities Parameters Id Selects target device See Table 29 Itemid Selects target capability See Table 30 This parameter can also input temperature ID Table 3 to get is it supports in SusiThermalProtection function pValue Pointer to a buffer that receives the target capability Return Status Code Condition Return Value Library uninitialized SUSI STATUS NOT INITIALIZED pValue NULL SUSI STATUS INVALID PARAMETER Unknown Id or Itemld SUSI STATUS UNSUPPORTED Success SUSI STATUS SUCCESS Table 30 Thermal Protection capabilities item Id Item Id Description SUSI ID TP EVENT SUPPORT FLAGS Event support flags See Table 31 SUSI ID TP EVENT TRIGGER MAXIMUM The maximum temperature to trigger event SUSI ID TP EVENT TRIGGER MINIMUM The minimum temperature to trigger event SUSI ID TP EVENT CLEAR MAXIMUM The maximum temperature to clear event SUSI ID TP EVENT CLEAR MINIMUM The minimum temperature to clear event Table 31 Thermal Protection Support Flags Flag Name Description Value SUSI THERMAL FLAG SUPPORT SHUTDOWN Supports shutdown event 0x01 SUSI_THERMAL_FLAG_SUPPORT_THROTTLE
29. USI ID HWM VOLTAGE DN 5V millivolts SUSI ID HWM VOLTAGE 12V 12V millivolts SUSI ID HWM VOLTAGE 5VSB 5V Standby millivolts SUSI ID HWM VOLTAGE 3VSB 3V Standby millivolts SUSI ID HWM VOLTAGE VBAT CMOS Battery voltage millivolts SUSI ID HWM VOLTAGE 5NV 5V millivolts SUSI ID HWM VOLTAGE 12NV 12V millivolts SUSI ID HWM VOLTAGE VTT DIMM voltage millivolts SUSI ID HWM VOLTAGE 24V 24V millivolts SUSI_ID_HWM_VOLTAGE_OEM0 3 Other voltages millivolts Table 3 Board temperature value ID Id Description Unit SUSI ID HWM TEMP CPU CPU temperature 0 1 Kelvins SUSI ID HWM TEMP CHIPSET Chipset temperature 0 1 Kelvins SUSI ID HWM TEMP SYSTEM System temperature 0 1 Kelvins SUSI ID HWM TEMP CPU2 CPU2 temperature 0 1 Kelvins SUSI ID HWM TEMP OEMO0 5 Other temperatures 0 1 Kelvins Table 4 Board fan speed value ID Id Description Unit SUSI ID HWM FAN CPU CPU fan speed RPM SUSI ID HWM FAN SYSTEM System fan speed RPM SUSI ID HWM FAN CPU2 Second CPU fan speed RPM SUSI ID HWM FAN OEMO0 6 Other fans RPM Table 5 Board support information value ID Id Description Mask flags SUSI SMBUS EXTERNAL SUPPORTED SUSI ID SMBUS SUPPORTED SUSI SMBUS OEMO SUPPORTED SUSI SMBUS OEM1 SUPPORTED SUSI SMBUS OEM2 SUPPORTED a MMM SUSI SMBUS OEM3 SUPPORTED Mask flags SUSI DC EXTERNAL SUPPORTED SUSI ID I2C SUPPORTED SUSI I2C OEMO SUPPORTED SUSI 12C_OEM1_SUPPORTED SUSI 12C_OEM2_SUPPORTED 3 2 2 SusiBoardGetStringA uint32 t SUSI API SusiBoa
30. USI STATUS NOT INITIALIZED SUSI STATUS INVALID PARAMETER SUSI STATUS WRITE ERROR SUSI STATUS UNSUPPORTED SUSI STATUS UNSUPPORTED SUSI STATUS SUCCESS 3 10 Thermal Protection Functions The Thermal Protection function call is used to set hardware base thermal monitoring and notification It takes a pointer to an instance of structure SusiThermalProtect which is defined as follows typedef struct SusiThermalProtect uint32 t Sourceld uint32 t EventType uint32 t SendEventTemperature uint32 t ClearEventTemperature SusiThermalProtect PSusiThermalProtect Where Sourceld Setting thermal source ID here See Table 3 EventType This byte can set up a thermal protect event see Table 28 NOT every platform supports all event type SendEevntTemperature Unit is 0 1 Kelvins When thermal source goes over this value SUSI will send event according Event Type ClearEventTemperature Unit is 0 1 Kelvins When thermal source goes below this value and Event is sent SUSI will clear event according Event Type Table 28 Thermal Protection Event Type Event Type Name Description Value SUSI THERMAL EVENT SHUTDOWN SUSI THERMAL EVENT THROTTLE SUSI THERMAL EVENT POWEROFF SUSI THERMAL EVENT NONE Shutdown event Throttle event Power off event No event 0x00 0x01 0x03 OxFF Table 29 Thermal Protection ID Id Description SUSI_ID_THERMAL_PROTECT_1 SUSI_ID_THERMAL_PROTECT_2 SUSI_ID_
31. ble NULL Unknown Id Device unsupported Success Table 12 Screen status definition Name SUSI SCREEN ON SUSI SCREEN OFF 3 3 13SusiVgaSetSrceenEnable Return Value SUSI STATUS NOT INITIALIZED SUSI STATUS INVALID PARAMETER SUSI STATUS UNSUPPORTED SUSI STATUS UNSUPPORTED SUSI STATUS SUCCESS Description Screen ON Screen OFF uint32 t SUSI API SusiVgaSetScreenEnable uint32_t Id uint32 t Enable Description Sets the screen state of the selected device Parameters Id Selects target device Enable Screen state See Table 12 Return Status Code Condition Library uninitialized Unknown Id Device unsupported Success Return Value SUSI STATUS NOT INITIALIZED SUSI STATUS UNSUPPORTED SUSI STATUS UNSUPPORTED SUSI STATUS SUCCESS 3 4 12C Functions DC APIs supports standard 7 and 10 bits slave address mode I2C API also supports word command it need encode before set to parameter see Table 14 Table 13 ICID Id Description SUSI ID 126 EXTERNAL Main DC host device SUSI ID IC OEMO 2 Other IG host devices Table 14 I C command encode Type Description Standard command Byte command Word command 0x800000000 Ex 0x8000FABC Extend command No command 0x4000xxxx ignore command parameter 3 4 1 Susil2CGetCaps uint32_t SUSI API Susil2CGetCaps uint32_t Id uint82_t Itemld uint32 t pValue Description Gets DC capabilities Parameters Id Selects target device See Table 13 Itemid Selects ta
32. ction configuration uaaal Return Status Code Condition Return Value Library uninitialized SUSI STATUS NOT INITIALIZED pConfig NULL SUSI STATUS INVALID PARAMETER Wrong configuration SUSI STATUS INVALID PARAMETER Unknown Id SUSI STATUS UNSUPPORTED Success SUSI STATUS SUCCESS 3 9 Storage Functions Access storage information and read write data to the selected user data area Developers can use this area to store their own data Table 25 Storage ID Id Description SUSI ID STORAGE STD Standard storage device SUSI ID STORAGE OEMO 1 Other storage devices 3 9 1 SusiStorageGetCaps uint32 t SUSI API SusiStorageGetCaps uint32 t Id uint32 tltemld uint32_t pValue Description Reads the capabilities of the current GPIO implementation from the selected GPIO interface Parameters Id Selects target device See Table 25 Itemid Selects target capability See Table 26 pValue Pointer to a buffer that receives the target capability Return Status Code Condition Return Value Library uninitialized SUSI STATUS NOT INITIALIZED pValue NULL SUSI STATUS INVALID PARAMETER Unknown Id SUSI STATUS UNSUPPORTED Device not support SUSI STATUS UNSUPPORTED Success SUSI STATUS SUCCESS Table 26 Storage capabilities item Id Item Id Description SUSI ID STORAGE TOTAL SIZE Get storage total size in bytes SUSI ID STORAGE BLOCK SIZE Get storage block size in bytes SUSI ID STORAGE LOCK STATUS Get storage lock status See Table 27
33. e Pointer to a buffer that receives the target capability Return Status Code Condition Return Value Library uninitialized SUSI_STATUS_NOT_INITIALIZED pValue NULL SUSI _STATUS_INVALID_PARAMETER Unknown Id or Itemld SUSI _STATUS_UNSUPPORTED Success SUSI STATUS SUCCESS Table 18 Watchdog capabilities item Id Item Id Description SUSI ID WDT DELAY MAXIMUM The maximum delay time value SUSI ID WDT DELAY MINIMUM The minimum delay time value SUSI ID WDT EVENT MAXIMUM The maximum event time value SUSI ID WDT EVENT MINIMUM The minimum event time value SUSI ID WDT RESET MAXIMUM The maximum reset time value SUSI ID WDT RESET MINIMUM The minimum reset time value SUSI ID WDT UNIT MINIMUM The minimum unit value SUSI ID WDT DELAY TIME Current delay time setting SUSI ID WDT EVENT TIME Current event time setting SUSI ID WDT RESET TIME Current reset time setting SUSI ID WDT EVENT TYPE Current event type Table 19 3 6 2 SusiWDogStart uint32 t SUSI API SusiWDogsStart uint32 Id uint32 t DelayTime uint32 t EventTime uint32 t ResetTime uint32 t EventType Description Start the watchdog timer and set the parameters To adjust the parameters the watchdog must be stopped and then started again with the new values If the hardware implementation of the watchdog timer does not allow a setting at the exact time selected then SUSI API selects the next possible longer timing Parameters Id Selects targ
34. elected bits remain unchanged This parameter will be ignored when single pin mode Direction Sets the direction of the selected GPIO ports Return Status Code Condition Return Value Library uninitialized SUSI STATUS NOT INITIALIZED Bitmask 0 when bank mode SUSI STATUS INVALID PARAMETER Unknown Id SUSI STATUS UNSUPPORTED Success SUSI STATUS SUCCESS 3 7 4 SusiGPIOGetLevel uint32 t SUSI API SusiGPlOGetLevel uint32_t Id uint32 t Bitmask uint32_t pLevel Description Read level the from GPIO ports Parameters Id Selects target device See Table 20 Bitmask Value for a bit mask Only selected bits are changed unselected bits remain unchanged This parameter will be ignored when single pin mode pLevel Pointer to a buffer that receives the GPIO level Return Status Code Condition Return Value Library uninitialized SUSI STATUS NOT INITIALIZED pLevel NULL SUSI STATUS INVALID PARAMETER Bitmask 0 when bank mode SUSI STATUS INVALID PARAMETER Unknown Id SUSI STATUS UNSUPPORTED Success SUSI STATUS SUCCESS 3 7 5 SusiGPIOSetLevel uint32 t SUSI API SusiGPlOSetLevel uint32_t Id uint32 t Bitmask uint32 t Level et Description Write level to GPIO ports Depending on the hardware implementation writing multiple GPIO ports with the bit mask option does not guarantee a time synchronous change of the output levels Parameters Id Selects target device See Table 20 Bitmask Value for a bit mask Only selected
35. et device See Table 17 DelayTime Initial delay for the watchdog timer in milliseconds EventTime Watchdog timeout interval in milliseconds to trigger an event ResetTime Watchdog timeout interval in milliseconds to trigger a reset EventType To select one kind of event type See Table 19 Return Status Code Condition Return Value Library uninitialized SUSI STATUS NOT INITIALIZED Unknown Id SUSI STATUS UNSUPPORTED Wrong time range SUSI STATUS INVALID PARAMETER Success SUSI STATUS SUCCESS Table 19 Watchdog timer event type Event Type Description SUSI WDT EVENT TYPE NONE No event SUSI WDT EVENT TYPE IRQ IRQ event a SUSI WDT EVENT TYPE PWRBTN Power button event 3 6 3 SusiWDogStop uint32 t SUSI API SusiWDogStop uint32_t Id Description Stops the operation of the watchdog timer Parameters Id Selects target device See Table 17 Return Status Code Condition Return Value Library uninitialized SUSI STATUS NOT INITIALIZED Unknown Id SUSI STATUS UNSUPPORTED Success SUSI STATUS SUCCESS 3 6 4 SusiWDogTrigger uint32 t SUSI API SusiWDogTrigger uint32_t Id Description Trigger the watchdog timer Parameters Id Selects target device See Table 17 Return Status Code Condition Return Value Library uninitialized SUSI STATUS NOT INITIALIZED Unknown Id SUSI STATUS UNSUPPORTED Success SUSI STATUS SUCCESS 3 6 5 SusiWDogSetCallBack uint32_t SUSI API SusiWDogSetCallBack uint32_t Id
36. formation value ID 22 Table 6 Board information string ID 23 Table 7 Backlight Dsena eder bedende 25 Table 8 Backlight Enable Values n n a 25 Table 9 VGA capabilities item ld 26 Table 10 Brightness level range definition rasnrvnannrenonvrnnrrnnnnnrnnnnnnnnnnrnnnnranannnnennnnnrsrresnnrnsennenrnnn 28 Table 11 Brightness polarity detintton n nasa 30 Table 12 Screen status definition A 32 Rv 33 Table 14 Eege 33 Table 15 12C Capabilities item d 34 Table 16 SMBUS ID uuu u usa ae seein weed aa mashita ee ea eee 39 Table 1 Wat hdog D RBE 51 Table 18 Watchdog Capabilities item jd 51 Table 19 Watchdog timer event fwpe a 52 Table 20 GPO IP ER 55 Table 21 GPIO Capabilities item Idi 55 Table 22 Fan control Capabilities item d 60 Table 23 Control Support Flags n nuna 60 Table 24 Auto Support Flags venner renn nnnnnnnnnnennensnrnnannnnnnnnenenresnnrnnsenneeennn 60 Table 25 Storage ID WEE 63 Table 26 Storage Capabilities item jd 63 Table 27 Storage Lock Status i cccvccssavscesseascvecesasveaaaedivwesatans cesandssVeasaasveatas tuevedsbant cedasasd eassarweagaadinveds 64 Table 28 Thermal Protection Event Type asss 67 Table 29 Thermal Protection ID 67 Table 30 Thermal Protection capabilities item d 68 Table 31 Thermal Protection Support Flags aa a 68 1 Introduction SUSI A Bridge to Simplify amp Enhance HAN amp Application
37. gger unrkm at cin ah sleit drp mini def avert andet 53 3 65 SusiIWDogSetGallBack ees egene a aaah dee asia ese aes eats eae adie Maas 53 3 7 GPIO W en del 55 3 7 1 SUSIGPIOGEICADS EE 55 KEE EE RI EE 56 3 7 3 SusiGPIOSetDirection AAA 56 BLA SUSIGPIOGeILeVBI uu unu u dene e enge desse ENEE eene En 57 K WEE E E 57 3 8 SMART FAN FUNCTIONS i Rd 59 3 8 1 GusitanGontroltzeit apen 60 3 8 2 SusiFanControlGetConfig renner nn venn nere ennnnnennnnnnrnn enn ennnrnnnnnn 61 3 8 3 SusiFanControlSetConfig u nas 61 3 9 STORAGE FUNCTIONS men daa udi bi 63 8 9 1 Ee e EE 63 3 9 2 SusiStorageAreaRead L n nus 64 FG 3 9 3 SusiStorageAreaWrte EE 64 3 9 4 mSusiStorageAreaSelLock u 65 3 9 5 SusiStorageAreaSetUnlock L nere een nn nen nnrnnenrrnnennnnnnnn 66 3 10 THERMAL PROTECTION FUNCTIONS n snn 67 3 10 1 SusiThermalProtectionGeICaps I nn nunana 68 3 10 2 SusiThermalProtectionSetConfig nn nuna 69 3 10 3 SusiThermalProtectionGetConflig u n uuu 69 List of Tables Table 1 Board information value ID 21 Table 2 Board voltage value ID 21 Table 3 Board temperature value ID 22 Table 4 Board fan speed value ID 22 Table 5 Board support in
38. gt 1 amp amp pRBuffer NULL SUSI STATUS INVALID PARAMETER WriteLen 0 amp amp RBufLen 0 SUSI STATUS INVALID PARAMETER 3 l Unknown Id SUSI STATUS UNSUPPORTED Bus Busy SDA SDC low SUSI STATUS BUSY COLLISION Arbitration Error Collision Error On Write 1 write cycle SUSI STATUS BUSY COLLISION SDA Remains low Time out due to clock stretching SUSI STATUS TIMEOUT Address Non ACK SUSI STATUS NOT FOUND Write Non ACK SUSI STATUS WRITE ERROR Success SUSI STATUS SUCCESS 3 4 3 Susil2CReadTransfer uint32 t SUSI API Susil2CReadTransfer uint32 tld uint82_t Addr uint32 t Cmd uint8 t pBuffer uint32 t ReadLen Description Reads from a specific register in the selected DC device Reads from I C device at the TC address Addr the amount of ReadLen bytes to the buffer pBuffer while using the device specific command Cmd Depending on the addressed TC device Cmd can be a specific command or a byte offset Parameters Id Selects target device See Table 15 Addr Encoded 7 10 Bit DC Device Address Cmd Encoded C Device Command Index See Table 14 pBuffer Pointer to a buffer that receives the read data ReadLen Size in bytes of the buffer pointed to by the pBuffer parameter Return Status Code Condition Return Value Library uninitialized SUSI STATUS NOT INITIALIZED pBuffer NULL ReadLen 0 SUSI STATUS INVALID PARAMETER Unknown Id SUSI STATUS UNSUPPORTED Bus Busy SDA SDC low SUSI STATUS BUSY COLLISION l Arbitration
39. ht Backlight Brightness value Return Status Code Condition Library uninitialized Bright gt MAX value Bright lt MIN value Unknown Id Device unsupported Success 3 3 6 SusiVgaGetBacklightLevel Return Value SUSI STATUS NOT INITIALIZED SUSI STATUS INVALID PARAMETER SUSI STATUS UNSUPPORTED SUSI STATUS UNSUPPORTED SUSI STATUS SUCCESS uint32 t SUSI API SusiVgaGetBacklightLevel uint32_t Id uint32 t pLevel Description Reads the current brightness level of the selected flat panel display Parameters Id Selects target device See Table 7 pLevel Pointer to a buffer that receives the current backlight brightness level See Table 10 Return Status Code Condition Library uninitialized pLevel NULL Unknown Id Device unsupported Success Return Value SUSI STATUS NOT INITIALIZED SUSI STATUS INVALID PARAMETER SUSI STATUS UNSUPPORTED SUSI STATUS UNSUPPORTED SUSI STATUS SUCCESS Table 10 Brightness level range definition Name SUSI BAGKLIGHT LEVEL MAXIMUM SUSI BAGKLIGHT LEVEL MINIMUM 3 3 7 SusiVgaSetBacklightLevel Description Maximum backlight level is 9 Minimum backlight level is 0 uint32 t SUSI API SusiVgaSetBacklightLevel uint32_t Id uint32 t Level ge Sal ve Le Je 3 3 8 Description Sets the brightness level of the selected flat panel display Parameters Id Selects target device See Table 7 Level Backlight Brightness level See Table 10
40. ight Local Flat Panel 1 SUSI ID BACKLIGHT 2 Backlight Local Flat Panel 2 SUSI ID BACKLIGHT 3 Backlight Local Flat Panel 3 Table 8 Backlight Enable Values Name Description SUSI BAGKLIGHT SET ON Signifies that the Backlight be Enabled SUSI BAGKLIGHT SET OFF Signifies that the Backlight be Disabled 3 3 1 SusiVgaGetCaps uint32 t SUSI API SusiVgaGetCaps uint32 t Id uint32 t Itemld uint32_t pValue Description Gets VGA capabilities Parameters Id Selects target device See Table 7 Itemid Selects target capability See Table 9 pValue Pointer to a buffer that receives the target capability Return Status Code Condition Return Value Library uninitialized SUSI_STATUS_NOT_INITIALIZED pValue NULL SUSI _STATUS_INVALID_PARAMETER Unknown Id or Itemld SUSI _STATUS_UNSUPPORTED Success SUSI STATUS SUCCESS Et Table 9 VGA capabilities item Id Item Id Description SUSI ID VGA BRIGHTNESS MAXIMUM Maximum backlight value SUSI ID VGA BRIGHTNESS MINIMUM Minimum backlight value 3 3 2 SusiVgaGetBacklightEnable uint32 t SUSI API SusiVgaGetBacklightEnable uint32_t Id uint32 t pEnable Description Gets current Backlight Enable state for specified Flat Panel Parameters Id Selects target device See Table 7 pEnable Pointer to a buffer that receives the current backlight enable state See Table 8 Return Status Code Condition Return Value Library uninitialized SUSI STATUS NOT INITIALIZED pEnable NULL SUSI STATUS INV
41. ines chipset and library function support controlling application development through SUSI enhances reliability and brings peace of mind v Flexible Upgrade Possibilities SUSI supports an easy upgrade solution for customers Customers just need to install the new version SUSI that supports the new functions v Backward compatibility Support SUSI 3 0 iManager 2 0 and EAPI 1 0 interface Customers don t need to change any APIs in their applications 1 2 1 2 1 Environment Requirements Operating Systems Windows XP Embedded Windows XP Pro or Home Edition 32 bit Windows 7 x86 x64 WES7 x86 x64 Windows 8 Desktop x86 x64 Windows CE 5 6 7 Linux Project based request from your local FAE Android Project based request from your local FAE QNX Project based request from your local FAE VxWorks Project based request from your local FAE 2 SUSI Definition Susi4 h file includes the API declaration constants and flags that are required for programming 2 1 Status Codes All SUSI API functions immediately return a status code from a common list of possible errors Any function may return any of the defined status codes See the Appendix for more detailed information define SUSI STATUS NOT INITIALIZED OxFFFFFFFF Description The SUSI API library is not yet or unsuccessfully initialized SusiLiblnitialize needs to be called prior to the first access of any other SUSI API function Actions
42. must occur within the Event Timeout millisecond parameter Should a trigger not be called within the relevant time limit a system reset will occur The SUSI watchdog timer may support two stages If the watchdog is not triggered within the event timeout an NMI IRQ or hardware output will be generated Then the reset timeout becomes active If the watchdog timer is not triggered within the reset timeout a reset will be generated Initial timing A B C D l Delay Event Timeout l Reset Timeout Reboot time Timing after trigger E F G Event Timeout Reset Timeout l Reboot e time Where Stage A Watchdog is started Stage B Initial delay period is exhausted Stage C F Event is triggered NMI IRQ or PIN is triggered to allow for possible software recovery Stage D G System is reset Stage E Watchdog is Triggered Trigger Stop must be called before Stage C F to prevent event from being generated e Trigger Stop must be called before Stage D G to prevent the system from being reset Table 17 Watchdog ID Id Description SUSI ID WATCHDOG 1 First watchdog timer SUSI ID WATCHDOG 2 Second watchdog timer SUSI ID WATCHDOG 3 Third watchdog timer 3 6 1 SusiWDogGetCaps uint32 t SUSI API SusiWDogGetCaps uint32_t Id uint82_t Itemld uint32 t pValue Description Gets watchdog capabilities Parameters Id Selects target device See Table 17 Itemid Selects target capability See Table 18 pValu
43. on Error Collision Error On Write 1 write cycle SUSI STATUS BUSY COLLISION SDA Remains low Time out due to clock stretching SUSI STATUS TIMEOUT Address Non ACK SUSI STATUS NOT FOUND Write Non ACK SUSI STATUS WRITE ERROR Success SUSI STATUS SUCCESS 3 5 11SusiSMBI2CReadBlock uint32 t SUSI API SusiSMBI2CReadBlock uint32 tld uint8 t Addr uint8 t Cmd uint8_t pBuffer uint32_t pLength Description Read multi data using C block protocol from the target slave device in the SMBus Parameters Id Selects target device See Table 16 Addr Specifies the 8 bit device address ranging from 0x00 to OxFF Whether to give a 1 read or 0 write to the LSB of slave address could be ignored Cmd Specifies the offset or command of the device register to read data from pBuffer Pointer to a byte array in which the function reads the block data pLength Pointer to a byte in which specifies the number of bytes to be read and also return succeed bytes Return Status Code Condition Return Value Library uninitialized SUSI STATUS NOT INITIALIZED pBuffer NULL SUSI STATUS INVALID PARAMETER et Unknown Id SUSI STATUS UNSUPPORTED Device unsupported SUSI STATUS UNSUPPORTED Bus Busy SDA SDC low SUSI STATUS BUSY COLLISION Arbitration Error Collision Error On Write 1 write cycle SUSI STATUS BUSY COLLISION SDA Remains low Time out due to clock stretching SUSI STATUS TIMEOUT Address Non ACK SUSI STATUS NOT FOUND Write Non ACK SUSI STATUS WRIT
44. rdGetStringA uint32 tld char pBuffer uint32 t pBufLen Description Text information about the hardware platform Parameters Id Selects target string See Table 6 pBuffer Pointer to a buffer that receives the value s data pBufLen Pointer to a variable that specifies the size in bytes of the buffer pointed to by the pBuffer parameter When the function returns this variable contains the size of the data copied to pBuffer including the terminating null character Return Status Code Condition Return Value Library uninitialized SUSI STATUS NOT INITIALIZED pBufLen NULL SUSI STATUS INVALID PARAMETER pBufLen NULL amp amp pBufLen amp amp pBuffer NULL SUSI STATUS INVALID PARAMETER Unknown Id SUSI STATUS UNSUPPORTED Device unsupported SUSI STATUS UNSUPPORTED strlength 1 gt pBufLen SUSI STATUS MORE DATA Success SUSI STATUS SUCCESS Table 6 Board information string ID Id Description SUSI ID BOARD MANUFACTURER STR Board Manufacturer Name SUSI ID BOARD NAME STR Board Name M SUSI ID BOARD REVISION STR SUSI ID BOARD SERIAL STR SUSI ID BOARD BIOS REVISION STR SUSI ID BOARD HW REVISION STR SUSI ID BOARD PLATFORM TYPE STR Board Revision Board Serial Number Board BIOS Revision Hardware Revision Platform type 3 3 Backlight Functions This function sub set facilitates backlight control for Integrated flat panel displays typically LVDS Table 7 Backlight ID Id Description SUSI ID BACKLIGHT 1 Backl
45. rget capability See Table 15 pValue Pointer to a buffer that receives the target capability Return Status Code Condition Return Value Library uninitialized SUSI STATUS NOT INITIALIZED pValue NULL SUSI STATUS INVALID PARAMETER Unknown Id or Itemld SUSI STATUS UNSUPPORTED Success SUSI STATUS SUCCESS Table 15 12C capabilities item Id Item Id Description SUSI ID I2C MAXIMUM BLOCK LENGTH 12C maximum block length 3 4 2 Susil2CWriteReadCombine uint32 t SUSI API Susil2CWriteReadCombine uint32_t Id uint8_t Addr uint8 t pWBuffer uint32 t WriteLen uint8 t pRBuffer uint32 t ReadLen Description Universal function for read and write operations to the DC bus Parameters Id Selects target device See Table 15 Addr First byte of IC device address 7 bit address only pWBuffer Pointer to a buffer containing the data to be transferred This parameter can be NULL if the data is not required WriteLen Size in bytes of the information pointed to by the pWBuffer parameter If pWBuffer is NULL this will be ignored pRBuffer Pointer to a buffer that receives the read data This parameter can be NULL if the data is not required ReadLen Size in bytes of the buffer pointed to by the pRBuffer parameter If pRBuffer is NULL this will be ignored Return Status Code Condition Return Value Library uninitialized SUSI STATUS NOT INITIALIZED WriteLen gt 1 amp amp pWBuffer NULL SUSI STATUS INVALID PARAMETER RBufLen
46. ription Set DC clock frequency Parameters Id Selects target device See Table 15 Freq IG clock frequency value Unit Hz Return Status Code Condition Library uninitialized Unknown Id Device unsupported Success Return Value SUSI STATUS NOT INITIALIZED SUSI STATUS UNSUPPORTED SUSI STATUS UNSUPPORTED SUSI STATUS SUCCESS l 3 5 SMBus Functions SMBus is the System Management Bus defined by Intel Corporation in 1995 It is used in personal computers and servers for low speed system management communications Table 16 SMBus ID Id Description SUSI ID SMBUS EXTERNAL Main SMBus host device SUSI ID SMBUS OEMO 3 Other SMBus host devices 3 5 1 SusiSMBReadByte uint32 t SUSI API SusiSMBReadByte uint32_t Id uint8 t Addr uint8 t Cmd uint8_t pBuffer Description Read a byte of data from the target slave device in the SMBus Parameters Id Selects target device See Table 16 Addr Specifies the 8 bit device address ranging from 0x00 to OxFF Whether to give a 1 read or 0 write to the LSB of slave address could be ignored Cmd Specifies the offset or command of the device register to read data from pBuffer Pointer to a variable in which the function reads the byte data Return Status Code Condition Return Value Library uninitialized SUSI STATUS NOT INITIALIZED pBuffer NULL SUSI STATUS INVALID PARAMETER Unknown Id SUSI STATUS UNSUPPORTED Bus Busy SDA SDC low SUSI STATUS BUSY COLL
47. ription Watchdog capabilities item ID use in Susil2CGetCaps define SUSI_ID_GPIO_INPUT_SUPPORT define SUSI ID GPIO OUTPUT SUPPORT Description GPIO capabilities item ID use in SusiGPIOGetCaps define SUSI ID VGA BRIGHTNESS MAXIMUM define SUSI ID VGA BRIGHTNESS MINIMUM Description VGA capabilities item ID use in SusiVgaGetCaps define SUSI ID STORAGE TOTAL SIZE define SUSI ID STORAGE BLOCK SIZE define SUSI ID STORAGE LOCK STATUS define SUSI ID STORAGE PSW MAX LEN Description Storage capabilities item ID use in SusiStorageGetCaps define SUSI ID WDT DELAY MAXIMUM define SUSI ID WDT DELAY MINIMUM define SUSI ID WDT EVENT MAXIMUM define SUSI ID WDT EVENT MINIMUM define SUSI ID WDT RESET MAXIMUM define SUSI ID WDT RESET MINIMUM define SUSI ID WDT UNIT MINIMUM define SUSI ID WDT DELAY TIME define SUSI ID WDT EVENT TIME define SUSI ID WDT RESET TIME define SUSI ID WDT EVENT TYPE Description Watchdog capabilities item ID use in SusiWDogGetCaps define SUSI ID FC CONTROL SUPPORT FLAGS define SUSI ID FC AUTO SUPPORT FLAGS 0x00000000 0x00000000 0x00000001 0x00010000 0x00010001 0x00000000 0x00000001 0x00010000 0x00010000 0x00000001 0x00000002 0x00000003 0x00000004 0x00000005 0x00000006 0x0000000F 0x00010001 0x00010002 0x00010003 0x00010004 0x00000000 0x00000001 Description Fan control capabilities item ID use in SusiFanControlGetCaps define SUSI ID TP EVENT SUPPORT FL
48. rmation read to the buffer pointed to by the pBuffer parameter Return Status Code Condition Return Value Library uninitialized SUSI STATUS NOT INITIALIZED pBuffer NULL BufLen 0 SUSI STATUS INVALID PARAMETER Offset BufLen gt TotalSize SUSI STATUS INVALID BLOCK LENGTH Unknown Id SUSI STATUS UNSUPPORTED Write error SUSI STATUS WRITE ERROR Success SUSI STATUS SUCCESS 3 9 4 SusiStorageAreaSetLock uint32 t SUSI API SusiStorageAreaSetLock uint32_t Id uint8_t pBuffer uint32 t BufLen Description Lock a storage area for write protection Parameters Id Selects target device See Table 25 pBuffer Locks key buffer BufLen Number of key buffers Return Status Code Et 3 9 5 Condition Library uninitialized pBuffer NULL BufLen 0 Lock error Unknown Id Device not support Success SusiStorageAreaSetUnlock Return Value SUSI STATUS NOT INITIALIZED SUSI STATUS INVALID PARAMETER SUSI STATUS WRITE ERROR SUSI STATUS UNSUPPORTED SUSI STATUS UNSUPPORTED SUSI STATUS SUCCESS uint32 t SUSI API SusiStorageAreaSetUnlock uint32_t Id uint8 t pBuffer uint32 t Butt en Description Unlock a storage area for write protection Parameters Id Selects target device See Table 25 pBuffer Unlock key buffer BufLen Number of key buffers Return Status Code Condition Library uninitialized pBuffer NULL BufLen 0 Unlock error Unknown Id Device not support Success Return Value S
49. target slave device in the SMBus Parameters Id Selects target device See Table 16 Addr Specifies the 8 bit device address ranging from 0x00 to OxFF Whether to give a 1 read or 0 write to the LSB of slave address could be ignored Data Specifies the word data to be sent Return Status Code Condition Return Value Library uninitialized SUSI STATUS NOT INITIALIZED Unknown Id SUSI STATUS UNSUPPORTED Bus Busy SDA SDC low SUSI STATUS BUSY COLLISION Arbitration Error Collision Error On Write 1 write cycle SUSI STATUS BUSY COLLISION SDA Remains low Time out due to clock stretching SUSI STATUS TIMEOUT Address Non ACK SUSI STATUS NOT FOUND Write Non ACK SUSI STATUS WRITE ERROR Success SUSI STATUS SUCCESS 3 5 7 SusiSMBReadQuick uint32 t SUSI API SusiSMBReadQuick uint32_t Id uint8_t Addr Description Turn SMBus device function off on or disable enable a specific device mode Parameters Id Selects target device See Table 16 Addr Specifies the 8 bit device address ranging from 0x00 to OxFF Whether to give a 1 read or 0 write to the LSB of slave address could be ignored Return Status Code Condition Return Value Library uninitialized SUSI_STATUS_NOT_INITIALIZED Unknown Id SUSI STATUS UNSUPPORTED Bus Busy SDA SDC low SUSI_STATUS_BUSY_COLLISION Arbitration Error Collision Error On Write 1 write cycle SUSI STATUS BUSY COLLISION SDA Remains low Time out due to clock stretching SUSI STATUS TIMEOUT
50. x00030000 define SUSI ID DC SUPPORTED 0x00030100 Description Board supported information value ID use in SusiBoardGetValue define SUSI ID SMBUS EXTERNAL define SUSI ID SMBUS OEMO define SUSI ID SMBUS OEM1 define SUSI ID SMBUS OEM2 define SUSI ID SMBUS OEM3 Description UO N O SMBus device ID use in SMBus Functions define SUSI_ID_I2C_EXTERNAL define SUSI_ID_I2C_OEMO define SUSI_ID_I2C_OEM1 define SUSI ID DC OEM2 Description on CH DC device ID use in 12C Functions define SUSI ID GPIO GPIO NUM GPIO NUM define SUSI ID GPIO BANK BANK NUM 0x00010000 BANK NUM Description GPIO device ID use in GPIO Functions define SUSI ID BACKLIGHT 1 0 define SUSI ID BACKLIGHT 2 define SUSI ID BACKLIGHT 3 2 Description Backlight device ID use in Backlight Functions define SUSI ID STORAGE STD 0x00000000 define SUSI ID STORAGE OEMO 0x00000001 define SUSI ID STORAGE OEM1 0x00000002 Description Storage device ID use in Storage Functions define SUSI ID THERMAL PROTEGCT 1 0 En define SUSI ID THERMAL PROTECT 2 define SUSI ID THERMAL PROTEGCT 3 2 define SUSI ID THERMAL PROTEGCT 4 3 Description Thermal protection device ID use in Thermal Protection Functions define SUSI ID WATCHDOG 1 0 define SUSI ID WATCHDOG 2 define SUSI ID WATCHDOG 3 2 Description Watchdog device ID use in Watchdog Functions 3 l 2 3 TE AT Item ID define SUSI ID DC MAXIMUM BLOCK LENGTH Desc
Download Pdf Manuals
Related Search