SUB-20 User Manual - Dimax

More documents

Recommendations

Info

22SUB-20SUB-20 API};where:· sa - Slave Address· r_w - 0-write, 1-read· sz - size in bytes of data to read/write· act_sz - actual read/write size. This parameter will be filled by function· data - 64 bytes data buffer. For read transaction function will attempt to read sz bytes into buffer, for writetransaction function will attempt to write sz bytes from buffer. Maximal transaction size is 64 bytes· status - I2C transaction result (see I2C Status).Return valueOn success function returns 0. Otherwise error code. The "I2C Error" return value means that there was a failureat the master code transmit stage. Results of the HS transactions are reported in status field of thecorresponding transaction descriptor.Example/** Master Code 00001001* Write 4 bytes to slave 0x44* Write 2 bytes to slave 0x50* Read 8 bytes from slave 0x44*/struct sub_i2c_hs_xfer xfer[3] ={{ 0x44, 0, 4, 0, "\x10\x11\x12\x13", 0 },{ 0x50, 0, 2, 0, "\x20\x30", 0 },{ 0x44, 1, 8, 0, "", 0 }};rc = sub_i2c_hs_rw( hndl, 0x01, 3, xfer, stat );3.3.9 I2C StatusThe status of last I2C operation successful or not successful is stored in sub_i2c_status global variable definedin libsub.h asextern int sub_i2c_status;Following statuses are available:0x00 No errors0x08 START condition transmitted0x10 Repeated START condition transmitted0x18 SLA+W transmitted; ACK received0x20 SLA+W transmitted; NAK received0x28 Data byte transmitted; ACK received0x30 Data byte transmitted; NAK received0x38 Arbitration lost in SLA; or NAK received0x40 SLA+R transmitted; ACK received0x48 SLA+R transmitted; NAK received0x50 Data received; ACK has been returned0x58 Data received; NAK has been returned0xE0 Arbitration lost0xE1 Arbitration lost in START0xE2 Arbitration lost in STOP0xE3 Arbitration lost in read ACK0xE4 Arbitration lost in read NAK0xE5 Arbitration lost in write0xF8 Unknown error© 2013 xdimax.com rev 2.17
23SUB-20SUB-20 API0xFFIllegal START or STOP condition3.4 Bit-bang I2C MastersBeginning from the FW version 0.2.6 and library version 0.1.12.16, SUB-20 provides additional four independentI2C master channels on GPIO24..31 compatible with I2C specification 3.0.Header Pin GPIO Alternative I2C Master Function9 GPIO24 SCLx010 GPIO25 SDAx011 GPIO26 SCLx112 GPIO27 SDAx113 GPIO28 SCLx214 GPIO29 SDAx215 GPIO30 SCLx316 GPIO31 SDAx3Each channel can operate in Fast Plus (1000KHz), Fast (400KHz) and Standard (100KHz) modes. In Fast andStandard modes I2C masters support clock stretching.SDAx, SCLx Pull-upsConsidering the fact that bit-bang I2C channels share the GPIO pins with other SUB-20 modules, there are nointernal (mounted on SUB-20 board) pull-ups on these channels. Pull-ups must be provided on target board.Clock StretchingIn Fast and Standard modes bit-bang I2C masters support clock stretching. Clock stretching pauses atransaction by holding the SCL line LOW. The transaction cannot continue until the line is released HIGH again.Slaves can hold the SCL line LOW to force themaster into a wait state until the slave is ready.Functionssub_bb_i2c_configsub_bb_i2c_scansub_bb_i2c_readsub_bb_i2c_write3.4.1 sub_bb_i2c_configSynopsisint sub_bb_i2c_config( sub_handle hndl, int mode, int stretch_ms )Configure SUB-20 Bit-bang I2C Masters module. Configuration is common for all Bit-bang I2C channels.Parameters· mode - Bit-bang I2C Master mode. One of the following flags:BB_I2C_FAST_PFast Plus mode 1000KHzBB_I2C_FASTFast mode 400KHzBB_I2C_STDStandard mode 100KHz· stretch_ms - Clock stretching timeout up to 4194ms. Clock stretching feature is available in Fast and Standardmodes. If SCL line is hold LOW by I2C slave device longer than stretch_ms timeout, Bit-bang I2C functionwill fail and I2C Status will be set to 0xE0.© 2013 xdimax.com rev 2.17
Page 4 and 5: 4SUB-20© 2013 xdimax.com
Page 6 and 7: 6SUB-20SUB-20 Layout2 SUB-20 Layout
Page 8 and 9: 8SUB-20SUB-20 Layout2.2 SPI HeaderH
Page 10 and 11: 10SUB-20SUB-20 LayoutJP1JP2JP3JP4JP
Page 12 and 13: 12SUB-20SUB-20 Layoutvoltage can be
Page 14 and 15: 14SUB-20SUB-20 API3.1 Device Initia
Page 16 and 17: 16SUB-20SUB-20 APIGet version of sh
Page 18 and 19: 18SUB-20SUB-20 APIsub_i2c_freqsub_i
Page 20 and 21: 20SUB-20SUB-20 APIfollowing format:
Page 24 and 25: 24SUB-20SUB-20 APIReturn ValueOn su
Page 26 and 27: 26SUB-20SUB-20 APIError Codes, I2C
Page 28 and 29: 28SUB-20SUB-20 APISPI_CLK_8MHZSPI_C
Page 30 and 31: 30SUB-20SUB-20 APIL SS Low Byte Tra
Page 32 and 33: 32SUB-20SUB-20 API3.6 MDIO Function
Page 34 and 35: 34SUB-20SUB-20 API· *content - 16
Page 36 and 37: 36SUB-20SUB-20 APIGPIO Pin configur
Page 38 and 39: 38SUB-20SUB-20 APIGPIO in input sta
Page 40 and 41: 40SUB-20SUB-20 API3.7.7.1 sub_edge_
Page 42 and 43: 42SUB-20SUB-20 API3.7.8.1 sub_fpwm_
Page 44 and 45: 44SUB-20SUB-20 API· res_us - PWM m
Page 46 and 47: 46SUB-20SUB-20 APIParameters· data
Page 48 and 49: 48SUB-20SUB-20 API· Required DLL v
Page 50 and 51: 50SUB-20SUB-20 APIrx_msg_us>0 rx_by
Page 52 and 53: 52SUB-20SUB-20 API3.11.1.1 sub_fifo
Page 54 and 55: 54SUB-20SUB-20 API3.11.3 I2C SlaveC
Page 56 and 57: 56SUB-20Electrical Characteristics4
Page 58: 58SUB-20Ordering Information© 2013

SUB-20 User Manual - Dimax

You also want an ePaper? Increase the reach of your titles

Delete template?

Save as template?