manualshive.com logo in svg

SCT Scout SC4415, User Manual

Share
Download
SCT Scout SC4415 User Manual Download Page 38

 

 

 

Document# SCT-UM026FVC 

Page 38 of 46 

Confidential 

5.4.2

 

pullup 

Name 

pullup 

Queue  No 

Synopsis 

pullup 
pullup <VALUE> 

Description  Set the value of the internal pull-up resistors 

Detail 

Pull-Up value: 
Set the value of the SDA and SCL internal programmable pull-up resistors. The 
appropriate value depends on the physical characteristics of the I3C/I2C device 
connected. Adjusting the pull-up value will cause the bus to become uninitialized. 
0 = Disable internal pull-ups 
Range = 500 – 4500 Ohms 

Actual pull-up values may differ from the requested value. 

5.4.3

 

err_msg 

Name 

err_msg 

Queue  No 

Synopsis 

err_msg 
err_msg <ENABLE> 

Description  Enable or disable Bus Error reporting 

Detail 

Bus Error Messages: 
Enable or disable the reporting of I3C Bus specific errors. By default, all Bus Errors are 
reported to the user interface immediately after the occurrence of the error 
condition. For automated applications, it may be preferable to disable this feature. 
<ENABLE> Enable/Disable: 
0 = Disable 
1 = Enable (default) 

5.4.4

 

init 

Name 

init 

Queue  No 

Synopsis 

init 

Description  Initialize the I3C bus with the Bus Definition 

Detail 

Initialize/Reinitialize the I3C Bus using the current Bus Definition. 
Bus Initialization initiates the Dynamic Address Arbitration which assigns each device 
its dynamic address. Execute the ‘

view

’ command to obtain the assigned address for 

each device once Initialization is complete. 
For a Hot-Join only bus, simply execute this command without adding any entries to 
the Bus Definition. 

5.4.5

 

view 

Name 

view 

Queue  No 

Synopsis 

view 

Description  View the current Bus Definition 

Detail 

Displays a table of the current Bus Definition. 
Each column of the table is described in detail: 
INDEX 
The Index value is assigned based on the order in which devices are added to the Bus 
Definition using the ‘

add

’ command. The priority of the Dynamic Address assignment 

is assumed based on the value of the index where 0 is the highest priority. A device 
can be removed from the Bus Definition using the ‘

remove

’ command. 

SA 
The Static Address, if available, of the device defined on the bus. I2C devices must 
have a Static Address whereas it is optional for I3C devices. 
DA 
The Dynamic Address is assigned to the devices once Bus Initialization has occurred. 

Summary of Contents for Scout SC4415

Page 1: ...is document contains proprietary information and shall not be disclosed in whole or in part to any party without the expressed and written consent of an authorized representative of SignalCraft Technologies Inc 2013 UserManual SC4415 Scout Number SCT UM026Fvc Date 2019 08 23 ...

Page 2: ...ge 2 of 46 Confidential Revision History Revision Date Author Description 1 0 2017 11 03 K Sumlak Initial Release 1 1 2019 02 20 K Sumlak Update for release version 1980 1 2 2019 08 23 K Sumlak Update for release version 2030 ...

Page 3: ...O Interface 10 2 5 1 Pin Map 11 2 5 2 IO Details 12 2 5 3 VIO 12 2 6 Status LED 13 2 7 Physical Details 13 3 Programming 14 3 1 Overview 14 3 2 Command Interface 14 3 2 1 Prompts 14 3 2 2 Formatting 14 3 2 3 Help System 15 3 2 4 Command Queue 15 3 2 4 1 Immediate Mode 15 3 2 4 2 Buffer Mode 15 3 2 5 Data Queue 16 3 2 6 Events 17 3 3 Application Modes 18 3 3 1 Boot Mode 18 3 3 2 MIPI RFFE Mode 19 3...

Page 4: ...eneral Commands 27 5 1 1 version 27 5 1 2 update 27 5 1 3 license 27 5 1 4 mode 27 5 1 5 vio 27 5 1 6 led 28 5 1 7 status 28 5 1 8 read 28 5 1 9 buffer 28 5 1 10 trigger_in 29 5 1 11 trigger_out 29 5 1 12 clear 29 5 1 13 delay 30 5 1 14 gdw 30 5 1 15 gdr 30 5 1 16 gpw 30 5 1 17 gpr 31 5 2 RFFE Commands 31 5 2 1 clock 31 5 2 2 hsdr 31 5 2 3 rr 31 5 2 4 err 32 5 2 5 erl 32 5 2 6 rzw 32 5 2 7 rw 32 5...

Page 5: ...1 s_write 36 5 3 12 s_read 37 5 4 I3C Commands 37 5 4 1 clkset 37 5 4 2 pullup 38 5 4 3 err_msg 38 5 4 4 init 38 5 4 5 view 38 5 4 6 add 39 5 4 7 remove 39 5 4 8 new_da 39 5 4 9 hot_join 40 5 4 10 ccc_write 40 5 4 11 ccc_read 40 5 4 12 vendor_write 41 5 4 13 vendor_read 41 5 4 14 ibi_read 42 5 4 15 legacy_write 42 5 4 16 legacy_read 42 5 4 17 sdr_write 43 5 4 18 sdr_read 43 5 4 19 sdr_rsvd 44 5 4 ...

Page 6: ...Document SCT UM026FVC Page 6 of 46 Confidential 6 1 Support 46 6 2 Regulatory 46 6 2 1 FCC Compliance 46 ...

Page 7: ...n further expand the control and monitoring capabilities for any application For more details about the physical and electrical characteristics refer to Section 2 Determinism flexibility and efficiency have been key design principles for the SC4415 This enables users to perform various operations with guaranteed and predictable timing making Scout ideal for manufacturing and development applicatio...

Page 8: ...llustration of the enclosure Dimensions and other specifications can be found in Section 2 7 Figure 2 1 1 SC4415 Scout The exposed interfaces on the ends of the enclosure are shown below in Figure 2 1 2 and 2 1 3 Figure 2 1 2 Power and Data Connections Figure 2 1 3 Device Interface Detail about each interface can be found by referencing the item number shown in red against Table 2 1 1 Item Descrip...

Page 9: ...guages For a more interactive experience a simple terminal emulator application such as Tera Term or PuTTY can be used to establish a serial connection to Scout For the best experience ensure that the terminal emulator is set to a monospaced font such as Lucidia Console or Consolas The Serial configuration required to communicate with Scout is shown in Table 2 3 1 Description Value Baud Rate 9600 ...

Page 10: ...native programming interface Do not make any connections to the Ethernet connector at this time as this may cause undesirable behavior 2 5 IO Interface Scout has been designed with flexibility in mind For this reason the SC4415 utilizes a 30 pin 0 100 male header for the IO Interface Table 2 5 1 provides the details about the IO interface connector Description Value Manufacture Samtec Part Number ...

Page 11: ...ief functional description of each of the pin types Figure 2 5 1 1 IO Interface Pin Map Type Description VIO IO Voltage Reference Can be internally generated or externally supplied to establish a common IO voltage between Scout and the connected devices APIO Application Specific IO These pins are dedicated for application specific purposes which are mode dependent and are not available for general...

Page 12: ...3 Output Trigger Section 5 1 11 Table 2 5 2 1 TRIG IO Functionality All of the IO Interface pins have built in protection to ensure that the SC4415 is protected against accidental voltage surges such as Electrostatic Discharge ESD Table 2 5 2 2 lists the electrical specifications for the IO Interface Description Value Condition Operating range 0V VIO Absolute limit 0 5V min 4 6V max Typical capaci...

Page 13: ...dentify a specific Scout unit in a circumstance where multiple units may be connected to a single host computer and the relationship between the programming interfaces and the physical devices is unknown 2 7 Physical Details The physical dimensions of the SC4415 are detailed in Figure 2 7 1 Figure 2 7 1 Product Dimensions Additional specifications such as environmental weight and ESD protection ar...

Page 14: ...eral good practice it is important for automated applications to always wait to receive the command prompt prior to sending a new command Failure to do so can result in a potential data overflow which may cause the programming interface to become unresponsive Programming examples which follow this practice can be obtained by referring to Section 6 1 and visiting the Scout Support Portal If the com...

Page 15: ...rsion DESCRIPTION Get the system information DETAIL Display the serial number and version information 3 2 4 Command Queue The Command Queue is the mechanism that stores and processes specific commands received from the Programming Interface The commands that make use of the Command Queue are identified in Section 4 by the Queue field The behavior of the Command Queue can be modified in a number of...

Page 16: ...ration the amount of data returned will vary When accessing the Data Queue the data order is maintained such that the bytes received first are the first to be returned when read The data stored in the Data Queue is retained until it is read using the Read command Depending on the arguments provided with the Read command a portion or all of the available data may be returned When data is read or de...

Page 17: ...erface Such events may occur in order to communicate protocol related bus errors protocol interrupts or unexpected system related errors or warnings The types of events that may occur largely depend on the protocol Mode enabled Events are only communicated to the Programming Interface during idle time when a command is not being processed An Event is identified by the use of the Event Prompt as in...

Page 18: ... Set the application operation mode 5 1 4 vio Set the VIO voltage reference level or source 5 1 5 led Set the front panel LED state 5 1 6 status Get the system status and queue information 5 1 7 read Return and display the data contained in the Data Queue 5 1 8 buffer Enable Buffered Mode and select the active Command Queue 5 1 9 trigger_in Trigger the execution of commands queued 5 1 10 trigger_o...

Page 19: ...Table 3 3 2 1 1 For more information about the APIO pins refer to Section 2 5 1 APIO1 APIO2 APIO3 APIO4 APIO5 APIO6 APIO7 APIO8 SCLK SDATA Table 3 3 2 1 1 APIO Pin Mapping for RFFE Mode 3 3 2 2 Details The following features are available in this mode Register Read and Write Extended Register Read and Write Extended Register Long Read and Write Masked Register Write Half Speed Data Response HSDR C...

Page 20: ...SC4415 supports three individual Slave Select lines SS1 SS3 The APIO pin functions for SPI mode are shown in Table 3 3 3 1 1 For more information about the APIO pins refer to Section 2 5 1 APIO1 APIO2 APIO3 APIO4 APIO5 APIO6 APIO7 APIO8 CLK MOSI MISO SS1 SS2 SS3 Table 3 3 3 1 1 APIO Pin Mapping for SPI Mode 3 3 3 2 Details The following features are available in this mode Standard SPI Read and Wri...

Page 21: ...y communicate with the Slave device at SS1 or SS2 The Slave device connected to SS3 however requires an entirely different SPI configuration In this case the most efficient method is to again make use of the Config command to fully reconfigure the SPI interface Enable Buffer Mode Primary buffer 1 Configure Interface Set for Slave Select SS1 B config 1 0 0 8 8 2 2 10 B s_write 1 0x02 0x2D 0x1D01 Up...

Page 22: ...features are available in this mode I3C SDR Single Data Rate communications I3C HDR DDR Double Data Rate communications In Band Interrupts handling Device Hot Join support Select support for Common Command Codes CCC I2C Legacy communications as defined by the I3C specification Internal programmable pull up bus resistors Configurable Clock rates for I2C and I3C devices up to 12 5MHz The available c...

Page 23: ...ces at all times and I3C devices operating in I2C mode prior to Bus Initialization The Legacy I2C communications can be leveraged using the Legacy_read and Legacy_write commands The supported I3C communication types SDR HDR DDR and CCC require that the I3C bus is defined and initialized prior to use These I3C communications can be leveraged using the SDR_read and SDR_write DDR_read and DDR_write C...

Page 24: ...ple is shown below for each type of event E HOTJOIN An I3C device s Hot Joined the bus E IBIDATA I3C In Band Interrupt s detected E BUSERR I3C Bus Error occurred Due to the nature of Hot Join and IBI requests it is possible that the occurrence of these events may impact timing critical sequences executing using the Buffer command mode If this is a concern consider disabling slave initiated events ...

Page 25: ... expiration of the timeout the transfer will occur and the file will be processed 4 1 License Generally the licensed features as shown in Table 3 3 1 are selected at the time of purchase In this case the SC4415 will be delivered with the desired features already enabled In the event that licensed features are purchased for a device after the initial sale these features can be enabled by loading a ...

Page 26: ...e SC4415 To perform the System Firmware update follow the procedure described in Section 4 and the select option 1 from the Update menu This will prompt the transfer of the System Firmware file Once the transfer is initiated it may take a few moments for the transfer to complete Once the file has been transferred the new System Firmware is then written to the memory of the SC4415 This process may ...

Page 27: ... Synopsis license Description Get the licensed features available to this device Detail Display the licensed features activated for this device 5 1 4 mode Name mode Queue No Synopsis mode mode SELECT Description Set the active application mode Detail SELECT Application Mode Changing modes clears the Data and Command Queues sets VIO to 0 external clears any armed triggers and sets the command mode ...

Page 28: ...he number of data bytes that are available to be read from the Data Queue Command Queue Free Space Displays the number of commands that can be loaded into the Command Queue See buffer for detail about the Primary and Secondary Command Queues 5 1 8 read Name read Queue No Synopsis read NUM FORMAT Description Return and display the data contained in the Data Queue Detail Read Data Queue NUM Bytes to...

Page 29: ...ondary Queue 2 Hardware Trigger Executes each of the Command Queues depending on the edge transition of the hardware signal detected at the Trigger Input pin Positive Edge Primary Queue Negative Edge Secondary Queue REPEAT Repeated Trigger Repeat Trigger allows for the commands in the Command Queues to persist between multiple trigger signals When set the repeat option is latched until the clear c...

Page 30: ...in Mask bits For both the Pin Mask and the Pin Direction the binary bit position correlates to a specific GPIO pin i e bit 0 GPIO1 bit 7 GPIO8 MASK Pin Mask The Pin Mask determines which GPIO pins will take on the respective bit values contained in the Pin Direction Range 0x00 0xFF DIR Pin Direction Set the specified GPIO pin to either an input 0 or output 1 provided that the respective bit value ...

Page 31: ...on data the binary bit position correlates to a specific GPIO pin i e bit 0 GPIO1 bit 7 GPIO8 Returned read data can be accessed using the read command 5 2 RFFE Commands 5 2 1 clock Name clock Queue No Synopsis clock clock FREQ Description Set the RFFE SCLK rate Detail Set the SCLK frequency By default the clock is set to 26000 kHz Once set the actual frequency achieved is confirmed FREQ Clock Fre...

Page 32: ...opsis erl SA BC ADDR_H ADDR_L Description Perform an RFFE Extended Register Read Long operation Detail Extended Register Read Long SA Slave Address Address of the RFFE Slave device to communicate with Range 0 15 BC Byte Count Number of registers to read zero indexed Range 0 7 where 0 indicates 1 byte ADDR_H Register Address high byte High Address byte of the register to read Range 0x00 0xFF ADDR_L...

Page 33: ... indicates 1 byte ADDR Register Address Address of the register to write Range 0x00 0xFF DATAn Write Data Data to write to the register specified The number of data bytes must match the Byte Count specified Range 0x00 0xFF 5 2 9 ewl Name ewl Queue Yes Synopsis ewl SA BC ADDR_H ADDR_L DATA1 DATAn Description Perform an RFFE Extended Register Write Long operation Detail Extended Register Write Long ...

Page 34: ...s 5 3 1 clock Name clock Queue Yes Synopsis clock clock FREQ Description Set the SPI Clock Rate Detail Set the SPI Clock frequency By default the clock is set to 5000 kHz Once set the actual frequency achieved is confirmed FREQ Clock Frequency Specify the clock frequency in kilohertz Range 50 26000 kHz 5 3 2 config Name config Queue Yes Synopsis config config SPI_SELECT SEL_POL SPI_MODE CMD_WIDTH ...

Page 35: ...3 5 protocol Name protocol Queue Yes Synopsis protocol protocol SPI_MODE Description Set the SPI Protocol Mode Detail SPI_MODE Protocol Mode 0 Mode 0 CPOL 0 CPHA 0 1 Mode 1 CPOL 0 CPHA 1 2 Mode 2 CPOL 1 CPHA 0 3 Mode 3 CPOL 1 CPHA 1 CPOL Clock Polarity CPHA Clock Phase 5 3 6 w_command Name w_command Queue Yes Synopsis w_command w_command WIDTH Description Set the Command Word width Detail WIDTH Co...

Page 36: ... Wait Cycles before the read data Detail CYCLES Read Wait Cycles Insert a delay for read operations specified in clock cycles Use to account for bus turnaround time Refer to the slave device specification for timing details Range 0 255 Cycles 5 3 11 s_write Name s_write Queue Yes Synopsis s_write WORDS CMD ADDR DATA1 DATAn Description Perform an SPI Write operation Detail SPI Write Operation WORDS...

Page 37: ...SPI device manufacture Range 0x00 to w_command ADDR Register Address Register Address as specified by the SPI device manufacture Range 0x00 to the value of w_address Returned read data can be accessed using the read command 5 4 I3C Commands 5 4 1 clkset Name clkset Queue No Synopsis clkset clkset I3C_RATE I2C_RATE Description Set the SCLK rate for I3C and I2C devices Detail Set Clock Rate Set the ...

Page 38: ... No Synopsis init Description Initialize the I3C bus with the Bus Definition Detail Initialize Reinitialize the I3C Bus using the current Bus Definition Bus Initialization initiates the Dynamic Address Arbitration which assigns each device its dynamic address Execute the view command to obtain the assigned address for each device once Initialization is complete For a Hot Join only bus simply execu...

Page 39: ...move ALL INDEX Description Remove device s from the Bus Definition Detail Remove Device Remove one or all devices from the Bus Definition Removal of a standard I2C I3C device will cause the bus to become uninitialized effectively removing any Hot Join devices ALL Remove all devices from the Bus Definition INDEX Device Index Specify the device to remove using its Index value Issue the view command ...

Page 40: ... by the B Broadcast and or D Direct indicator INDEX Device Index Use the view command to obtain a device s Index To send a broadcast message specify the INDEX value as 0 Range 0 to Total number of devices CCC Common Command Code Specify the CCC command to execute 1 ENEC 2 DISEC 3 SETMWL 4 SETMRL 5 ENTTM Enable Slave Events Disable Slave Events Set Max Write Length Set Max Read Length Vendor Test M...

Page 41: ...irect CCC write can be performed as indicated by the B Broadcast and D Direct indicator INDEX I3C Device Index Use the view command to obtain a device s Index Range 0 to Total number of devices VSCCC Vendor Specific CCC Specify the command code to execute Range 0x61 0x7F B Range 0xE0 0xFE D BC Data Byte Count The number of data bytes to be written Range 0 128 DATAn Data Byte s Data Byte s to write...

Page 42: ...obtain a device s Index Range 1 to Total number of devices CMB Combined Message Specifies if this command is to be handled as a combined message with the command that follows Combining messages join multiple read and write operations together using Sr Repeated Start 0 Single Message 1 Combined with legacy_write or legacy_read This feature is only valid for use while Buffered Mode is enabled For mo...

Page 43: ...e as 0 Range 0 to Total number of devices CMB Combined Message Specifies if this command is to be handled as a combined message with the command that follows Combining messages join multiple read and write operations together using Sr Repeated Start 0 Single Message 1 Combined with sdr_write or sdr_read This feature is only valid for use while Buffered Mode is enabled For more information about Bu...

Page 44: ...the view command to obtain a device s Index Range 1 to Total number of devices CMB Combined Message Specifies if this command is to be handled as a combined message with the command that follows Combining messages join multiple read and write operations together using an HDR Restart 0 Single Message 1 Combined with ddr_write or ddr_read This feature is only valid for use while Buffered Mode is ena...

Page 45: ...ons together using an HDR Restart 0 Single Message 1 Combined with ddr_write or ddr_read This feature is only valid for use while Buffered Mode is enabled For more information about Buffered Mode see Buffer command details CMD HDR DDR Read Command Code The HDR DDR Read Command Code to include in the payload Range 0x80 0xFF WC Data Word Count The number of data words 2 Bytes to be read Range 1 64 R...

Page 46: ...nts of Part 15 pursuant to paragraph 15 103 c as being a digital device used exclusively as industrial or commercial test equipment Its operation is subject to the following conditions 1 This device may not cause harmful interference 2 This device must accept any interference received including interference that may cause undesired operation Although this equipment is exempt from the technical req...

Reviews:

No comments

Brands by name

Popular brands

Load more brands