Page History

...

Reference firmware description

In the following table is described the tasks executed by the reference firmware (Trenz Electronic v3.02).

Super loop

In this super loop ("while(1)") reference firmware is used to:

...

void activity(void){
        ep1_pool();
        int_pin_pool();
}

Manage incoming USB setup data packet (task 1)

Handles the setup package and the basic device requests like reading descriptors, get/set confifuration etc. It is used in phase of connection/disconnection of the TE USB FX2 module from host computer's USB port. It is also used by CyControl, CyConsole (and other similar programs) to retrieve information about the cofiguration of the USB device (TE USB FX2 module view as USB device).

...

Manage incoming USB data packet (task2)

This process is realized by function ep1_pool().

...

Test data for internal test;
if (in the EP1 OUT FIFO exist at least one USB command packet not yet readed)
{
	Increment command count;
	Fill output buffer EP1INBUF with 0xFF value;
	switch(EPOUTBUF[0])         //Decode USB FX2 API Command correponding to received EPOUTBUF[0]
	    default:                // EPOUTBUF[0] different from any USB FX2 API encoded value  			
			Code to execute if EPOUTBUF[0] does not equal the value of any of the cases		
			break;
        ...
		case USB_FX2_API_0xYZ:  // EPOUTBUF[0] = USB_FX2_API_0xYZ , USB_FX2_API encoded value hexadecimal YZ	
			Run the correspoding code snippet/function with auxiliary functions (if any) 
			Write the reply (if any) in EP1INBUF
			Set a flag_new_data to indicate that a USB reply packet could be delivered to host computer's USB
			break;
		...
	
	Free input buffer;
    if (flag_new_data = 1)    //Check the flag to know if a USB reply packet should be delivered to host computer's USB 
	{
		if(it is possible to send the USB reply packet using EP1)
		{	
			Send the USB reply packet using EP1
			Reset the flag flag_new_data to indicate that a USB reply packet has been delivered to host computer's USB 
			//the buffer is free for use
		}
	}
}		

Manage interruption (INT0 pin) incoming from FPGA chip (task 3: Pull INT pool)

Mainly used with XPS_I2C_SLAVE custom IP block and the FW APIs SET_INTERRUPT command, GET_INTERRUPT command.

Pull INT pool. Brief description.

If

• an autoresponse interrupt is preconfigured (in the ep1_pool()) by host computer's SW and
• an FPGA_INT0 "interrupt" rised by FPGA chip should be managed (FPGA_INT0=1),

...

The host computer's SW should use a polling procedure to retrieve the I2C bytes read (and stored) by FX2 microcontroller (the pull response to host computer's pull is realized by task2: ep1_pool())

Pull INT pool.  Longer description true for every Logical Architecture Layer

If

• an autoresponse interrupt is preconfigured (by host computer's SW using SET_INTERRUPT => CMD_SET_AUTORESPONSE => sts_int_auto_configured = 1) and
• an FPGA_INT0 "interrupt" rised by FPGA chip should be managed (FPGA_INT0=1),

...

This byte array coul be pulled out by host computer'SW using SET_INTERRUPT ( => CMD_GET_AUTORESPONSE => for(i = 0; i < 32; i++) EP1INBUF[i+1] = auto_response_data[i];).

Pull INT pool. Longer description true for Reference Design: Logical Archirecture Layer = Reference Architecture Layer

It is usually used with XPS_I2C_SLAVE custom IP block (LINK) for command, settings and status communication. When MicroBlaze write data to MB2FX2_REG0, the interrupt pin INT0 (aka FPGA_INT0 in firmware files) is rised. This pin is connected to PA0/INT0 pin of FX2 microcontroller. When the FX2 microcontroller's firmware read the rise of pin INT0 (=1 because MicroBlaze writes data to MB2FX2_REG0) it set the firmware variable FPGA_INT0 to 1.

...