PSoC 1 I 2 C Bootloader

Transcription

1 Objective Project Name: PSoC1_I2C_Bootloader Programming Language: C Associated Part: All PSoC 1 Families Software Version: PD 5.2 SP1 Related Hardware: CY3210 PSoC Eval1 Board Author: Jie Yuan This project demonstrates how to create an I 2 C bootloader for PSoC 1. The bootloader allows the device to be reprogrammed over an I 2 C communication interface. This project is implemented with a CY8C PXI and uses a CY3240 USB-I2C Bridge as the I 2 C host. However, the I 2 C Bootloader User Module is available for all I 2 C enabled PSoC 1 devices. Overview The I 2 C bootloader User Module implements a bootloader that can reprogram the PSoC device over the I 2 C communication interface. Bootloading can be useful for any device that needs to be reprogrammed in the field. The bootloading information can be sent through an I 2 C master device, such as a CY3240 USB-I2C Bridge (used in this example) or an in-system host processor. This project is implemented with a CY8C PXI, but any PSoC 1 device with I 2 C functionality can support bootloading. The latest I 2 C bootloader user module (V2.10) provides three I 2 C topology options, including I 2 C operation for bootloader only, software only, and full I 2 C API support with bootloader. This project uses the I 2 C bootloader User Module with full API support option to implement a bootloader. To demonstrate how the bootloading works, first program a PSoC device with one application, and then bootload the device with the Bridge Control Panel (I 2 C PC host software) over the CY3240 USB-I2C Bridge. This document provides a working project using the I 2 C bootloader user module and a brief overview of the project settings required for the bootloader. For a detailed description of the I 2 C bootloader, refer to the I 2 C bootloader data sheet and I 2 C bootloader tutorial available in the documentation folder in PSoC Designer. Additional information on where to find these documents can be found in the Reference section on page 7. User Module List and Placement This table lists the user modules used in this project and the hardware resources occupied by each user module. BootLdrI2C_1 User Module Placement System Resource User Module Parameter Settings This table shows the user module parameter settings for each user module used in the project. User Module Name: BootLdrI2C_1 Parameter Value Comments Slave_Addr_HEX 0x1 Selects the I 2 C slave address as0x1. Boot_Loader_Addr_HEX 0x0 Selects the bootloader address as0x0. Read_Buffer_Types RAM ONLY Only RAM data buffer is used. Communication_Service_Type Interrupt Selects Interrupt as data processing strategy. ApplicationCode_Start_Block 0x29 Select the 0x29 block as the first block of application code. BootLoderKey Selects the default value for the bootloader verification key. Flash_Program_Temperature_deg_C 20C Selects 20 C as the typical programming temperature. March 24,

2 User Module Name: BootLdrI2C_1 Parameter Value Comments Ignore_N_I2C_Prefix_Bytes 2 Sets the bootloader to ignore the 2 prefix bytes. BootLdrI2C_ver 0x1000 Selects 0x1000 as the version of the bootloader. I 2 C Clock 100K Standard Sets the I 2 C clock as 100 khz. I2C_Pin P[1]0-P[1]1 Selects P1[0] and P1[1] for I 2 C communication. P1[0] is SDA and P1[1] is SCL. Notes When the Read_Buffer_Types is set to RAM ONLY, only RAM buffers are transmitted over I 2 C. To read and transmit data from the flash buffer, set the read buffer type to RAM or FLASH. The parameter Communication_Service_Type allows you to select an interrupt based data process strategy or polled strategy. In an interrupt based strategy, an ISR routine is included which handles data movement. The transfer is initiated against a predefined buffer, and data is then quickly moved in or out of the buffer in the background. In the polled based strategy, you are in control of when the data movement takes place. To implement a polled strategy, the function BootLdrI2C_Poll() must be periodically called and each time a single byte is transferred. The parameter ApplicationCode_Start_Block sets the first block of bootloadable/writeable application code. It is also used by the bootloader tools to determine what blocks of code to process for a.dld file and what blocks of code to calculate checksums on. The bootloader key value makes sure the bootloader upgrade utility is not accidentally invoked. The program temperature parameter to the actual temperature during bootloading impacts memory retention and maximum number of write cycles. Therefore, ensure that the bootloader is never operated more than 20 C from the value in this parameter. The parameter Ignore_N_I2C_Prefix_Bytes allows you to configure the bootloader to ignore a variable number of prefix bytes. This parameter is mainly used in the RS-232 to I 2 C translator project and also used for the case of certain SM-bus protocols based on I 2 C. The I 2 C clock parameter sets the clock speed to run the I 2 C interface. If I 2 C clock is set to 400 khz, the CPU_Clk_speed must be greater than 6 MHz. There is no need to select the proper drive mode for I 2 C pins because PSoC Designer does this automatically. Global Resources Important Global Resources Parameter Value Comments Power Setting [Vcc/SysClk freq] 5.0 V/24 MHz Selects 5 V operation and 24 MHz SysClk. CPU_Clock SysClk/2 Selects 12 MHz as the clock input for the CPU. SysClk Source Internal Selects internal system clock Note This table lists the global resources that are specific to the project. Other parameters are left at their default value or configured as required. March 24,

3 Pin Configuration Important Pin Configuration Pin Select Drive Interrupt Comments P2[0], P2[1] StdCPU Strong DisableInt Selects P2[0] and P2[1]pins to drive LEDs. Hardware Connections The schematic diagram for the project follows. Only two LEDs and an I 2 C connection are required. All of these elements are readily available on a CY3210 PSoC Eval1 board. Firmware On reset, device configuration is loaded and then code in main.c is executed. The following operations are performed by the firmware: Start the bootloader running in the background Enable global interrupt. An infinite loop is entered, and it turns LED1 on and turns LED2 off. Operation Section 1: How to Generate a Bootloadable Application 1. Review the I 2 C bootloader datasheet (V2.10) thoroughly. 2. Create a PSoC chip-level project and place the BootLdrI2C User Module, selecting Full I 2 C API Support with Bootloader. 3. In the Parameters window, set the parameters as shown in the User Module Parameter Settings section. March 24,

4 4. In the menu bar, open the Project > Settings dialog box, and select IMAGECRAFT as C compiler. 5. Right click the user module icon and select Boot Loader Tools. 6. Click Get Files. The boot.tpl, custom.lkp, and flashsecurity.example files are placed in the project root directory. Then, close the Boot Loader Tools wizard. March 24,

5 7. Open flashsecurity.txt and change the security as shown. block 0 and 1 are set as write protected W, block 2, 3, and 4 are set as unprotected U, and starting address 0xA40 to the end of flash are set as unprotected U. The blocks between block 5 and block 40 are set as write protected W for Bootloader Code. If additional memory space is needed for the bootloader, the value of ApplicationCode_Start_Block can be increased and additional blocks can be set to write protected (W). 8. Review the example code in the main.c file or copy it to your own project main.c file. Then, generate/build the project. Note that the.hex file created in this step cannot be directly downloaded to the PSoC 1 device because the application code needs the Rebuild Project with Valid Checksum to validate the.hex file checksum. If directly downloaded to the PSoC 1 device, the code is not correctly executed. 9. The project should be generated and built successfully with no error at this point. If there is any error, you must fix it before proceeding to the next step. 10. Right click the user module icon and select Boot Loader Tools. 11. Click Rebuild Project with Valid Checksum. The new checksum is calculated and displayed in green text. This second build is required because the checksum from the application code must be calculated after an initial build and then included in the final hex file during the final build. 12. Click Generate Download file. Three files (.dld,.txt, and.iic) are generated in the project output folder. At the bottom of the wizard, in the status box, the paths of these files are visible in green text. 13. Go to the project output folder and rename the PSoC1_I2C_Bootloader.hex, PSoC1_I2C_Bootloader.dld, and PSoC1_I2C_Bootloader.txt files to B1led_PSoC1_I2C_Bootloader.hex, B1led_PSoC1_I2C_Bootloader.dld, and B1led_PSoC1_I2C_Bootloader.txt respectively. This ensures these bootloader files are not overwritten when the second bootloadable application is generated. 14. In main.c, in the while loop, change the PRT2DR = 0x01; to PRT2DR = 0x02;. 15. Rebuild your project and repeat steps 10 through 12. This generates the second set of bootloadable files, such that two separate applications can be bootloaded. 16. Go to the project output folder and rename the PSoC1_I2C_Bootloader.hex, PSoC1_I2C_Bootloader.dld, and PSoC1_I2C_Bootloader.txt files to B2led_PSoC1_I2C_Bootloader.hex, B2led _PSoC1_I2C_Bootloader.dld, and B2led _PSoC1_I2C_Bootloader.txt respectively. 17. By now, you have created two bootloader applications. The first bootloader application turns on an LED on P2_0 and the second bootloader application turns on an LED on P2_1. Ensure the LEDs are connected to P2_0 and P2_1 before proceeding to the next step. 18. Program your device with the B1led_PSoC1_I2C_Bootloader.hex file using Miniprog1. With this hex file, LED1 on P2_0 should be on and other LEDs are off when the part is powered. March 24,

6 Section 2: How to Bootload This section explains the process for bootloading the second application into the part. 1. Open a bridge control panel (BCP). If you have PSoC Programmer 3.12 or a later version, the BCP should be in the C:\Program Files\Cypress\Bridge Control Panel\1.2 directory. 2. Connect the USB-I 2 C bridge to your PC and click Connect on the BCP at the bottom right corner. The status bar must display Connected (highlighted in green). You must also connect the USB-I 2 C bridge to your device on P1_0 and P1_1. Normally, you can do this by connecting to the ISSP header that is used for programming. 3. Turn on the power by clicking Toggle Power on the BCP at the bottom right corner. If everything works properly, LED1 on P2_0 should be on as it was from step 18 of the previous section. 4. Click List at the bottom left corner to see all the detected I 2 C addresses. You should see them as shown in the bottom display of the BCP. 5. From the BCP menu bar, click on File > Open I2C BL File and navigate to your project output file and select/open B2led_PSoC1_I2C_Bootloader.txt. 6. Check the Send all strings checkbox at the bottom of the BCP. Bootload the application by clicking the Send button to the left of the checkbox. Wait for the bootload process to complete. 7. If the bootload process completes successfully, LED2 on P2_1 should be on. Otherwise, the bootload process has failed. When bootload is successful, the second and third byte of response data is 0x20. See the Slave Address Read Responses table in the data sheet for more information. response data March 24,

7 8. Bootloading can also be done using the.dld file. To demonstrate this process, you can bootload the B1Led application again to turn on the LED on P2_0. Steps 9 to 13 outline this process. 9. From the BCP menu bar, click on Tools > I2C Bootloader to open I 2 C bootloader window. 10. Click File Name and navigate to your project output file and select/open B1led_PSoC1_I2C_Bootloader.dld. 11. In the I 2 C bootloader window, check Autodetection Off, select the Address as 00, and then click Download. If you directly click Download with Autodetection On and the Address undefined as the previous picture shows, an error message pop sup as shown in the following screenshot. 12. Click OK to close the error message. Ensure the Bootloader I 2 C address is selected in the Address field in the I 2 C bootloader window. For this project, the Bootloader address is 0x00. Click Download again to start bootloading. 13. If the bootload process completes successfully, LED1 on P2_0 should be on. Output Application code B1led LED1 LED2 Power On ON OFF Application code B2led LED1 LED2 Power On OFF ON References For more information on I 2 C bootloader, refer to the following documents: The following I 2 C bootloader datasheets (V2.10) are available in the latest PSoC Designer 5.1 SP1 Build 2101 software folder: Datasheet for the 64-byte flash block device family. You can find it in the following path: C:\Program Files\Cypress\PSoC Designer\5.1\Documentation\User_Module_Datasheets\StdUM\BootLdrI2C Datasheet for the 128-byte flash block device family. You can find it in the following path: C:\Program Files\Cypress\PSoC Designer\5.1\Documentation\User_Module_Datasheets\CY8C20060\BootLdrI2C. I 2 C Bootloader User Module(V2.10) provides three I 2 C topology options, including I 2 C operation for bootloader only, software only, and full I 2 C API support with bootloader. Note that the software only option is only supported by the 128- byte flash block device family. This project demonstrates the I 2 C bootloader User Module with full API support option. There are three tutorials to show you how to create an I 2 C bootloader project with three different options. You can find them at the following location: C:\Program Files\Cypress\PSoC Designer\5.1\Documentation\Supporting Documents. March 24,

8 PSoC is a registered trademark of Cypress Semiconductor Corp. "Programmable System-on-Chip," PSoC Designer, and PSoC Express are trademarks of Cypress Semiconductor Corp. All other trademarks or registered trademarks referenced herein are the property of their respective owners. Cypress Semiconductor 198 Champion Court San Jose, CA Phone: Fax: Cypress Semiconductor Corporation, The information contained herein is subject to change without notice. Cypress Semiconductor Corporation assumes no responsibility for the use of any circuitry other than circuitry embodied in a Cypress product. Nor does it convey or imply any license under patent or other rights. Cypress products are not warranted nor intended to be used for medical, life support, life saving, critical control or safety applications, unless pursuant to an express written agreement with Cypress. Furthermore, Cypress does not authorize its products for use as critical components in life-support systems where a malfunction or failure may reasonably be expected to result in significant injury to the user. The inclusion of Cypress products in life-support systems application implies that the manufacturer assumes all risk of such use and in doing so indemnifies Cypress against all charges. This Source Code (software and/or firmware) is owned by Cypress Semiconductor Corporation (Cypress) and is protected by and subject to worldwide patent protection (United States and foreign), United States copyright laws and international treaty provisions. Cypress hereby grants to licensee a personal, non-exclusive, non-transferable license to copy, use, modify, create derivative works of, and compile the Cypress Source Code and derivative works for the sole purpose of creating custom software and or firmware in support of licensee product to be used only in conjunction with a Cypress integrated circuit as specified in the applicable agreement. Any reproduction, modification, translation, compilation, or representation of this Source Code except as specified above is prohibited without the express written permission of Cypress. Disclaimer: CYPRESS MAKES NO WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, WITH REGARD TO THIS MATERIAL, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. Cypress reserves the right to make changes without further notice to the materials described herein. Cypress does not assume any liability arising out of the application or use of any product or circuit described herein. Cypress does not authorize its products for use as critical components in life-support systems where a malfunction or failure may reasonably be expected to result in significant injury to the user. The inclusion of Cypress product in a life-support systems application implies that the manufacturer assumes all risk of such use and in doing so indemnifies Cypress against all charges. Use may be limited by and subject to the applicable Cypress software license agreement. March 24,