Get Connected with USB on RX62N RX62N USB

Transcription

1 Get Connected with USB on RX62N RX62N USB LAB PROCEDURE Description: This lab is an introduction to the Renesas USB solution using an RX62N RSK. The RX USB block supports both Host and Function operation and the stack provides support for both. In this lab the user will learn how to use the Host and Function APIs to create a data-logger device, transfer files from a PC to the RX62N over XModem and also read and write data from a Mass Storage device. Lab Objectives 1. Learn to run the USB CDC demo 2. Use XModem to download files over USB 3. Learn to use the RX USB Host stack to read and write data from a Mass Storage Device. Lab Materials Please verify you have the following materials at your lab station. E1 Debugger pod RX62N RSK Flash drive 5V power supply HEW v4 USB Mini A-B (2) USB A-B (2) Skill Level 1. Basic familiarity with HEW 2. Good understanding of C, data structures and pointers. Time to Complete Lab 120 Minutes Lab Sections 1 Using the CDC API Using XModem over CDC Using the Mass Storage Host API...11 Get Connected with USB on RX62N v1.0 Page 1 of 16

2 1 Using the CDC API LAB PROCEDURE Overview: In this session, you will learn how to use the CDC API to display a Menu over a virtual COM port on a terminal session, and send and receive data. Procedural Steps Step 1.1 Step 1.2 Step 1.3 Step 1.4 Step 1.5 Step 1.6 Step 1.7 Step 1.8 Step 1.9 Open the workspace at C:Workspace\ 222L_USB_RX62N \Lab1 by clicking on Lab1.hws Connect the E1 to the RSK using the ribbon cable if it is not already connected. Plug in power to the board and connect the E1 via USB to the PC. Change the session to RX600_E1_E20_SYSTEM from the session pull-down box and click Connect In the E1 connection dialogue box, ensure that the MCU Device Group and Device is set to RX62N and R5F562N8 respectively. Also make sure that the Debugging Mode radio button is checked and then click OK. In the Configuration Properties window, set Mode to On-chip ROM enabled extended mode and the Input Clock (EXTAL) to 12 MHz. Click OK. You should now be connected to the device. Check by making sure that the disconnect button is active The pseudo-code for the next few steps are 1. Initialize the USB_CDC stack 2. Check to see if the device is connected 3. Wait until some data is received from the terminal so that you know that the terminal session has started. 4. Display a Menu 5. If the Echo option is chosen, read the character from the terminal and send it back so that it is echoed onto the terminal Open usb_cdc.h to see all the available CDC API functions. Open usb_cdc_app.c. Step 1.10 In the function USB_CDC_APP_Main(), initialize the CDC stack by using USBCDC_Init(). Step 1.11 Now create a while (1) loop after the initialization function. The rest of the code will be written in this loop. Step 1.12 Wait until the cable has been connected by using the USBCDC_IsConnected() function. while(false == USBCDC_IsConnected()); Get Connected with USB on RX62N v1.0 Page 2 of 16

3 Step 1.13 Create a global unsigned char rx_char. Step 1.14 Wait until a character is received from the terminal session on the PC by using the blocking function USBCDC_GetChar(). USBCDC_GetChar( &rx_char ); Step 1.15 Use the blocking function USBCDC_WriteString() to display the string Press Switch SW1." onto the terminal. USBCDC_WriteString("\r\n Press Switch SW1.\r\n"); Step 1.16 Since the rest of the steps below need to run only while the cable is connected, create a while loop that checks to see if the cable is connected. The steps after this (unless otherwise instructed) will run within this loop while(usbcdc_isconnected()) { //remaining steps } Step 1.17 The global variable gswitchflag will be set by pre-written interrupt routines for pushbutton switches 1, 2 and 3 on the RSK. For definitions on the values that gswitchflag can be set to, refer to switch.h Step 1.18 Check gswitchflag to see if Switch1 was pressed. if(switchpress_1 & gswitchflag) { //steps if SW1 was pressed } Step 1.19 If SW1 was pressed, then display the menu from the predefined strings szwelcomemsg1-5 as defined on lines in usb_cdc_app.c. Use USBCDC_WriteString() to display these strings onto the terminal. USBCDC_WriteString(szWelcomeMsg1); USBCDC_WriteString(szWelcomeMsg2); USBCDC_WriteString(szWelcomeMsg3); USBCDC_WriteString(szWelcomeMsg4); USBCDC_WriteString(szWelcomeMsg5); Step 1.20 Clear the gswitchflag global variable and close the if statement from Step 1.18 Step 1.21 Check gswitchflag to see if Switch2 was pressed. if(switchpress_2 & gswitchflag) { //steps if SW2 was pressed } Step 1.22 If SW2 was pressed, then start the Echo mode. Using USBCDC_WriteString() print the string Echo mode started Get Connected with USB on RX62N v1.0 Page 3 of 16

4 Step 1.23 Use USBCDC_Read_Async() to start a non-blocking read of size BUFFER_SIZE, into the buffer g_buffer and call the call-back function CBDoneRead once the read is completed. BUFFER_SIZE, g_buffer and CBDoneRead are already defined. USBCDC_Read_Async(BUFFER_SIZE, g_buffer, CBDoneRead); The call-back function CBDoneRead will be called either when a BUFFER_SIZE worth of data has been read or when a packet smaller than the BULK IN endpoint buffer size has been received. In USB transactions, if a packet smaller than the FIFO size is received, this is an indication that the data transfer is complete. Step 1.24 Add code to clear the gswitchflag global variable and then close the if statement from Step Step 1.25 The empty call back function CBDoneRead is defined at the end of usb_cdc_app.c, and the arguments passed to it are the error code (_err) and the number of bytes read (_NumBytes). In the following steps, we will use these arguments to complete the call-back function. Step 1.26 The next 2 steps are to be done in the call-back function, CBDoneRead. Step 1.27 Check to see if the error code is USB_ERR_OK and then use USBCDC_Write_Async() to start a non-blocking write of size _NumBytes from the buffer g_buffer and call the call-back function CBDoneWrite once the write is complete. if(usb_err_ok == _err) { USBCDC_Write_Async(_NumBytes, g_buffer, CBDoneWrite); } The call-back function CBDoneWrite will be called once a _NumBytes worth of data has been written. In this lab we are not doing anything once the write is complete and so CBDoneWrite is an empty function. Step 1.28 Now start off the next non-blocking read operation using the USBCDC_Read_Async() function. USBCDC_Read_Async(BUFFER_SIZE, g_buffer, CBDoneRead); Get Connected with USB on RX62N v1.0 Page 4 of 16

5 Step 1.29 Returning to the function USB_CDC_APP_Main(), check gswitchflag to see if Switch3 was pressed. if(switchpress_3 & gswitchflag) { //steps if SW3 was pressed } Step 1.30 If SW3 was pressed, then cancel any pending CDC calls to the stack by calling USBCDC_Cancel(). Step 1.31 Print Echo Stopped to the terminal using USBCDC_WriteString(); Step 1.32 Clear the gswitchflag global variable and close the if statement from Step Step 1.33 Compile by clicking on the Build All an incremental build click on Build button. This only needs to be done the first time. For to build the new image faster. Step 1.34 Run the project by clicking on the Reset-Go icon. Step 1.35 Connect the USB0_D port on the RSK to the PC using the provided USB cable. Step 1.36 Open Terra-Term using the shortcut on the desktop. Step 1.37 Select the Serial radio-button and from the Port pull-down menu choose CDC USB Demonstration Figure 1:TerraTerm Connection Dialogue Get Connected with USB on RX62N v1.0 Page 5 of 16

6 Step 1.38 Press any key on the PC once and then follow the on-screen instructions to run the program. Step 1.39 Once you are done close Terra Term. Step 1.40 Disconnect the USB cable between the PC and the RSK. Step 1.41 Click on Stop to stop the program. Step 1.42 Close HEW. Get Connected with USB on RX62N v1.0 Page 6 of 16

7 2 Using XModem over CDC LAB PROCEDURE In this lab you will learn to use the XModem API and transfer a file from the PC to the RX62N. The XModem protocol has been ported to run on the USB CDC class example so that real life applications that require sending and receiving files over USB can be supported. Note that in its current state there is only support to send files to the MCU from the PC. The workspace in this lab is very similar to what you would have had at the end of the last session except that now there is XModem support and the menu options are a little different. SW2 is now used to enable/disable A/D data logging and SW3 will be used to enable file transfers. Step 2.1 The pseudo-code for this session is as follows: 1. Check to see if SW3 is pressed 2. If SW3 is pressed, then print a message to TerraTerm indicating that we are ready to being download. 3. Use the XModemDowloadOverUSB function to start XMODEM download. 4. Use the call-back function to assemble each 128 byte packet. 5. Check the return value from XModemDowloadOverUSB() to determine is the transfer was a success or not. 6. Print a message indicating success or failure 7. Look at memory to see contents of received file. Step 2.2 Open the workspace at C:Workspace\ 222L_USB_RX62N \Lab2 by clicking on Lab2.hws and navigate to usb_cdc_app.c The user interface to XModem consists of a single function call XmodemDownloadOverUSB() which takes as its argument a callback function that will be called when one block (132 bytes) of data is received. Step 2.3 Step 2.4 Refer to the steps Step 1.2 to Step 1.6 from session 1 to connect to the RX62NRSK. Around line 102 ( before main() ), declare the prototype for a call-back function which takes as its arguments an unsigned char BlockNumber, an unsigned char pointer to the Source and returns an unsigned char. unsigned char CB_XmodemBlock( unsigned char BlockNum, unsigned char *DataPtr); Step 2.5 Step 2.6 Jump to line 195 where the status of the switch variable gswitchflag is checked to see if Switch 3 was pressed. Print the string Select file to transfer over XModem to the terminal using the blocking function USBCDC_WriteString USBCDC_WriteString( Select file to transfer over XModem ); Get Connected with USB on RX62N v1.0 Page 7 of 16

8 Step 2.7 Step 2.8 Create a new local unsigned char ret to store the return value from the main Xmodem function call. Now call the function XmodemDownloadOverUSB() (after USBCDC_WriteString() in Step 2.6 ), with the call back function declared in Step 2.4 as its argument as shown below ret = XmodemDownloadOverUSB((unsigned long) CB_XmodemBlock); Step 2.9 If the return value ret is a non-zero value, then using USBCDC_WriteString(), print XModem File Transfer complete ; if not, then print XModem File Transfer Failed. if( ret == 0 ) USBCDC_WriteString("\n\n XModem File Transfer complete. \r\n"); else USBCDC_WriteString("\n XModem File Transfer Failed. r\n"); Step 2.10 Now, the callback function has to be defined. At the end of the file usb_cdc_app.c, create a definition for the call back function CB_XmodemBlock declared in Step 2.4 unsigned char CB_XmodemBlock( unsigned char BlockNum, unsigned char *DataPtr) { // CallBack function body// } Step 2.11 Since the callback function is called after each whole block of XModem data is received, this function serves as an assembler routine to assemble all the blocks into a destination buffer. Step 2.12 Use the pre-declared global buffer StagingArea[ ] which has a declared size of 128*5 (STAGING_AREA_SIZE) bytes. Step 2.13 Create a for loop and other required variables (as shown below) to copy 128 bytes of data from the source pointer (which is a received argument to this function) to the StagingArea buffer, and return a 0 when done. Loop the buffer around if the StagingArea buffer becomes full. unsigned char i; static unsigned long SAindex=0; // append most recent packet to data in staging area for( i = 0; i < 128; i++ ) { StagingArea[SAindex] = DataPtr[i]; SAindex++; if( SAindex == STAGING_AREA_SIZE ) SAindex = 0; } return 0; Get Connected with USB on RX62N v1.0 Page 8 of 16

9 Step 2.14 Compile by clicking on the Build All an incremental build click on Build button. This only needs to be done the first time. For to build the new image faster. Step 2.15 Make sure the code is downloaded by double-clicking on the.abs file in the navigation panel on the left. Step 2.16 Run the project by clicking on the Reset-Go icon. Step 2.17 Connect the USB0_D port on the RSK to the PC using the provided USB cable. Step 2.18 Open Terra-Term using the shortcut on the desktop. Step 2.19 Select the Serial radio-button and from the Port pull-down menu choose CDC USB Demonstration Step 2.20 Press any key on the PC once to begin executing the user app created in the above steps Step 2.21 Press SW3 to start the File Transfer process on the MCU. Step 2.22 Now on TerraTerm, use the steps shown in the image below to select the file for download. Figure 2: TerraTerm File Transfer Dialogue Get Connected with USB on RX62N v1.0 Page 9 of 16

10 Step 2.23 Navigate to C:\WorkSpace\222L_USB_RX62N \Lab2 and select test.txt to download. Step 2.24 Once the download is complete stop the program by clicking on Stop Step 2.25 Open the memory window by clicking on or using Ctrl+M and enter the values as shown in Figure 3 below and click OK. Note that you can select any other labels by clicking on the icon at the right end of the Display Address pull down menu. Figure 3: Memory Display Address Selection Step 2.26 You should now be able to see the contents of the test.txt file that was transferred over USB using XModem Step 2.27 Press F5 to run the code. Step 2.28 Remember that you have to press SW3 each time before downloading a new file. Occasionally there will be a few seconds delay before a download starts. Step 2.29 Try transferring the larger text file provided in C:\WorkSpace\222L_USB_RX62N \Lab2 Step 2.30 Once you are done, first close TerraTerm and then stop the code by clicking on Stop Step 2.31 Disconnect the USB cable between the PC and the RSK. Step 2.32 Close HEW. Get Connected with USB on RX62N v1.0 Page 10 of 16

11 3 Using the Mass Storage Host API The main objective of this session is to demonstrate the simplicity of using standard file operations to interface to a mass storage device in an embedded system. In this lab session you will use the Renesas USB Mass Storage Host API to enumerate a Mass Storage device, mount it and use STDIO commands to open a file, read and write information to it and then un-mount the drive. The information being written in this case is a 5/10 array that contains 50 simulated A2D values. Step 3.1 Step 3.2 Step 3.3 Step 3.4 Open the workspace at C:Workspace\ 222L_USB_RX62N \Lab3 by clicking on RX62NUSBH.hws. Refer to the steps Step 1.2 to Step 1.6 from session 1 to connect to the RX62NRSK. Open main.c and jump to the main() function. Create a file pointer as shown below FILE *pfile=0; Step 3.5 Mount all available devices using the dskmountalldevices() function which returns the total number of devices mounted. Stay here in a while loop until dskmountalldevices() returns a value greater than 0 indicating that a mass storage device is mounted. while( 0== dskmountalldevices()); If the number of Mass Storage devices mounted is non-zero, this means that a device has been mounted and is available for use. The drive letter assignment to devices starts with A and is incremented for each additional Mass Storage Device enumerated. Step 3.6 Use the built-in LED macro to turn on LED0 to indicate that a Mass Storage Device has been enumerated and mounted. (LED0 is located near the RESET push-button). led_on(id_led0); Step 3.7 Use fopen() with the file pointer created in Step 3.4 to open the file RX62N.wri on the Mass Storage Drive in append mode. pfile = fopen("a:\\rx62n.wri", "a+"); Get Connected with USB on RX62N v1.0 Page 11 of 16

12 Step 3.8 Step 3.9 Check to see if fopen() returned a valid pointer If the pointer is valid, then use fread() to read the first 10 characters in the file into the provided string buffer str[15]. if (pfile) { fread(str,10,1,pfile); //code in the next steps will be within this if until specified According to ANSI standards, when performing fwrite() and fread() operations on a file that is opened in the a+ mode, it is necessary to use an operation like fseek() in between fread() and fwrite() operations. Step 3.10 Using strncmp() verify that the read string in str[ ] is DevCon2010. If the strings are the same strncmp() returns a 0. Note: strncmp() is case sensitive when doing string comparison. if(0 == strncmp(str,"devcon2010",10)) { Get Connected with USB on RX62N v1.0 Page 12 of 16

13 int fseek(file *stream_pointer, long offset, int origin); Argument meaning: 1. stream_pointer is a pointer to the stream FILE structure of which the position indicator should be changed; 2. offset is a long integer which specifies the number of bytes from origin where the position indicator should be placed; 3. origin is an integer which specifies the origin position. It can be: o SEEK_SET: origin is the start of the stream o SEEK_CUR: origin is the current position o SEEK_END: origin is the end of the stream Step 3.11 If strncmp returns a successful compare (return value of 0), then use fseek to position the file pointer. fseek(pfile,0,seek_cur); Step 3.12 Using a simple for loop as shown below, print out all the values from the char buffer g_a2dbuffer[10][5] into the file RX62N.wri. for(i=0;i<=6;i++) { for(j=0;j<=4;j++) { fprintf(pfile,"%d ",g_a2dbuffer[i][j]); } fprintf(pfile," \n \r"); } Step 3.13 Once all the data has been printed and both for loops closed, close the file-stream using fclose(). fclose(pfile); Get Connected with USB on RX62N v1.0 Page 13 of 16

14 Step 3.14 Close the if statement opened on Step Step 3.15 Close the if statement opened on Step 3.9. Step 3.16 Un-mount the drive using dskejectmedia(). Stay here in a loop until the drive is ejected. while ( 0 == dskejectmedia('a')); Step 3.17 Use the built-in LED macro to turn off LED0 to indicate that a Mass Storage Device has been un-mounted. (LED0 is located near the RESET push-button). led_off(id_led0); Step 3.18 Compile by clicking on the Build All an incremental build click on Build button. This only needs to be done the first time. For to build the new image faster. Step 3.19 Make sure the code is downloaded by double-clicking on the.abs file in the navigation panel on the left. Step 3.20 Run the project by clicking on the Reset-Go icon. Step 3.21 Plug in the provided Mass Storage Device to the PC and make sure that the file RX62N.wri is available and the first entry in the file is DevCon2010. Get Connected with USB on RX62N v1.0 Page 14 of 16

15 Step 3.22 Observe LED0. On plugging in the Mass Storage Device to the RX62N RSK, LED0 should turn on and then off indicating that a Mass Storage Device was enumerated and then unmounted. Step 3.23 Once LED0 turns off, plug the drive into the PC and read the contents of RX62N.wri in notepad. The contents of the buffer g_a2dbuffer[ ][ ] should be available as shown below. Figure 4: RX62N.wri after fwrite(). Step 3.24 Click on Stop to stop the program. BONUS Section Step 3.25 Use other STDIO function calls like fgetc(), fputc() and ftell() to read and write information to the Mass Storage device Step 3.26 Done. Get Connected with USB on RX62N v1.0 Page 15 of 16

16 Using the TotalPhase USB Sniffer Step 3.27 Setup the system as shown in the picture below PC USB Mini A-B E1 Ribbon Cable RX62N USB A-B USB A-B Beagle USB Mini A-B Step 3.28 Remember that the lab can be done with this system in place. Step 3.29 Run the data center program by running Data Center.exe from the desktop Step 3.30 From the GUI select Analyzer>>Connect to Analyzer. The Beagle will show up in the dialogue window if it was connected as shown in the picture above. Step 3.31 Click on the Play button to start recording USB data Step 3.32 You can use the different filters to view selected data. For eg: if you just want to see Bulk In and Bulk Out, filter out everything else but the Bulk endpoints. Get Connected with USB on RX62N v1.0 Page 16 of 16