| |
| /* |
| * (C) Copyright 2008 - 2009 |
| * Windriver, <www.windriver.com> |
| * Tom Rix <Tom.Rix@windriver.com> |
| * |
| * This program is free software; you can redistribute it and/or |
| * modify it under the terms of the GNU General Public License as |
| * published by the Free Software Foundation; either version 2 of |
| * the License, or (at your option) any later version. |
| * |
| * This program is distributed in the hope that it will be useful, |
| * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| * GNU General Public License for more details. |
| * |
| * You should have received a copy of the GNU General Public License |
| * along with this program; if not, write to the Free Software |
| * Foundation, Inc., 59 Temple Place, Suite 330, Boston, |
| * MA 02111-1307 USA |
| * |
| * The logical naming of flash comes from the Android project |
| * Thse structures and functions that look like fastboot_flash_* |
| * They come from bootloader/legacy/include/boot/flash.h |
| * |
| * The boot_img_hdr structure and associated magic numbers also |
| * come from the Android project. They are from |
| * system/core/mkbootimg/bootimg.h |
| * |
| * Here are their copyrights |
| * |
| * Copyright (C) 2008 The Android Open Source Project |
| * All rights reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions |
| * are met: |
| * * Redistributions of source code must retain the above copyright |
| * notice, this list of conditions and the following disclaimer. |
| * * Redistributions in binary form must reproduce the above copyright |
| * notice, this list of conditions and the following disclaimer in |
| * the documentation and/or other materials provided with the |
| * distribution. |
| * |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS |
| * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE |
| * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, |
| * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, |
| * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS |
| * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED |
| * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
| * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT |
| * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
| * SUCH DAMAGE. |
| * |
| */ |
| |
| #ifndef FASTBOOT_H |
| #define FASTBOOT_H |
| |
| #include <common.h> |
| #include <command.h> |
| |
| #include <asm/byteorder.h> |
| //#include <asm/arch/hardware.h> |
| #include <asm/arch/cpu.h> |
| #include <asm/io.h> |
| |
| /* This is the interface file between the common cmd_fastboot.c and |
| the board specific support. |
| |
| To use this interface, define CONFIG_FASTBOOT in your board config file. |
| An example is include/configs/omap3430labrador.h |
| ... |
| #define CONFIG_FASTBOOT 1 / * Using fastboot interface * / |
| ... |
| |
| An example of the board specific spupport for omap3 is found at |
| cpu/omap3/fastboot.c |
| |
| */ |
| |
| /* From fastboot client.. */ |
| #define FASTBOOT_INTERFACE_CLASS 0xff |
| #define FASTBOOT_INTERFACE_SUB_CLASS 0x42 |
| #define FASTBOOT_INTERFACE_PROTOCOL 0x03 |
| |
| #define FASTBOOT_VERSION "0.5" |
| |
| /* The fastboot client uses a value of 2048 for the |
| page size of it boot.img file format. |
| Reset this in your board config file as needed. */ |
| #ifndef CFG_FASTBOOT_MKBOOTIMAGE_PAGE_SIZE |
| #define CFG_FASTBOOT_MKBOOTIMAGE_PAGE_SIZE 2048 |
| #endif |
| |
| struct cmd_fastboot_interface |
| { |
| /* This function is called when a buffer has been |
| recieved from the client app. |
| The buffer is a supplied by the board layer and must be unmodified. |
| The buffer_size is how much data is passed in. |
| Returns 0 on success |
| Returns 1 on failure |
| |
| Set by cmd_fastboot */ |
| int (*rx_handler)(const unsigned char *buffer, |
| unsigned int buffer_size); |
| |
| /* This function is called when an exception has |
| occurred in the device code and the state |
| off fastboot needs to be reset |
| |
| Set by cmd_fastboot */ |
| void (*reset_handler)(void); |
| |
| /* A getvar string for the product name |
| It can have a maximum of 60 characters |
| |
| Set by board */ |
| char *product_name; |
| |
| /* A getvar string for the serial number |
| It can have a maximum of 60 characters |
| |
| Set by board */ |
| char *serial_no; |
| |
| /* Nand block size |
| Supports the write option WRITE_NEXT_GOOD_BLOCK |
| |
| Set by board */ |
| unsigned int nand_block_size; |
| |
| /* Transfer buffer, for handling flash updates |
| Should be multiple of the nand_block_size |
| Care should be take so it does not overrun bootloader memory |
| Controlled by the configure variable CFG_FASTBOOT_TRANSFER_BUFFER |
| |
| Set by board */ |
| unsigned char *transfer_buffer; |
| |
| /* How big is the transfer buffer |
| Controlled by the configure variable |
| CFG_FASTBOOT_TRANSFER_BUFFER_SIZE |
| |
| Set by board */ |
| unsigned int transfer_buffer_size; |
| |
| }; |
| |
| /* Android-style flash naming */ |
| typedef struct fastboot_ptentry fastboot_ptentry; |
| |
| /* flash partitions are defined in terms of blocks |
| ** (flash erase units) |
| */ |
| struct fastboot_ptentry |
| { |
| /* The logical name for this partition, null terminated */ |
| char name[16]; |
| /* The start wrt the nand part, must be multiple of nand block size */ |
| unsigned long start; |
| /* The length of the partition, must be multiple of nand block size */ |
| unsigned long length; |
| /* Controls the details of how operations are done on the partition |
| See the FASTBOOT_PTENTRY_FLAGS_*'s defined below */ |
| unsigned int flags; |
| }; |
| |
| /* Lower byte shows if the read/write/erase operation in |
| repeated. The base address is incremented. |
| Either 0 or 1 is ok for a default */ |
| |
| #define FASTBOOT_PTENTRY_FLAGS_REPEAT(n) (n & 0x0f) |
| #define FASTBOOT_PTENTRY_FLAGS_REPEAT_MASK 0x0000000F |
| |
| /* Writes happen a block at a time. |
| If the write fails, go to next block |
| NEXT_GOOD_BLOCK and CONTIGOUS_BLOCK can not both be set */ |
| #define FASTBOOT_PTENTRY_FLAGS_WRITE_NEXT_GOOD_BLOCK 0x00000010 |
| |
| /* Find a contiguous block big enough for a the whole file |
| NEXT_GOOD_BLOCK and CONTIGOUS_BLOCK can not both be set */ |
| #define FASTBOOT_PTENTRY_FLAGS_WRITE_CONTIGUOUS_BLOCK 0x00000020 |
| |
| /* Sets the ECC to hardware before writing |
| HW and SW ECC should not both be set. */ |
| #define FASTBOOT_PTENTRY_FLAGS_WRITE_HW_ECC 0x00000040 |
| |
| /* Sets the ECC to software before writing |
| HW and SW ECC should not both be set. */ |
| #define FASTBOOT_PTENTRY_FLAGS_WRITE_SW_ECC 0x00000080 |
| |
| /* Write the file with write.i */ |
| #define FASTBOOT_PTENTRY_FLAGS_WRITE_I 0x00000100 |
| |
| /* Write the file with write.yaffs */ |
| #define FASTBOOT_PTENTRY_FLAGS_WRITE_YAFFS 0x00000200 |
| |
| /* Write the file as a series of variable/value pairs |
| using the setenv and saveenv commands */ |
| #define FASTBOOT_PTENTRY_FLAGS_WRITE_ENV 0x00000400 |
| |
| /* Use mmc command to read/write this partition */ |
| #define FASTBOOT_PTENTRY_FLAGS_USE_MMC_CMD 0x00010000 |
| |
| /* Use movi command to read/write this partition */ |
| #define FASTBOOT_PTENTRY_FLAGS_USE_MOVI_CMD 0x00020000 |
| |
| /* Status values */ |
| #define FASTBOOT_OK 0 |
| #define FASTBOOT_ERROR -1 |
| #define FASTBOOT_DISCONNECT 1 |
| #define FASTBOOT_INACTIVE 2 |
| |
| /* Magic string to enable fastboot during preboot */ |
| #define FASTBOOT_REBOOT_MAGIC "REBOOT-FASTBOOT" |
| #define FASTBOOT_REBOOT_MAGIC_SIZE 15 |
| |
| /* Android bootimage file format */ |
| #define FASTBOOT_BOOT_MAGIC "ANDROID!" |
| #define FASTBOOT_BOOT_MAGIC_SIZE 8 |
| #define FASTBOOT_BOOT_NAME_SIZE 16 |
| #define FASTBOOT_BOOT_ARGS_SIZE 512 |
| |
| #define FASTBOOT_BOOTLOADER_MAGIC "BOOTLDR!" |
| |
| /* Input of fastboot_tx_status */ |
| #define FASTBOOT_TX_ASYNC 0 |
| #define FASTBOOT_TX_SYNC 1 |
| |
| struct fastboot_boot_img_hdr { |
| unsigned char magic[FASTBOOT_BOOT_MAGIC_SIZE]; |
| |
| unsigned kernel_size; /* size in bytes */ |
| unsigned kernel_addr; /* physical load addr */ |
| |
| unsigned ramdisk_size; /* size in bytes */ |
| unsigned ramdisk_addr; /* physical load addr */ |
| |
| unsigned second_size; /* size in bytes */ |
| unsigned second_addr; /* physical load addr */ |
| |
| unsigned tags_addr; /* physical addr for kernel tags */ |
| unsigned page_size; /* flash page size we assume */ |
| unsigned unused[2]; /* future expansion: should be 0 */ |
| |
| unsigned char name[FASTBOOT_BOOT_NAME_SIZE]; /* asciiz product name */ |
| |
| unsigned char cmdline[FASTBOOT_BOOT_ARGS_SIZE]; |
| |
| unsigned id[8]; /* timestamp / checksum / sha1 / etc */ |
| }; |
| |
| |
| #define FASTBOOT_BOOTLDR_IMG_NUM 2 |
| |
| struct fastboot_bootldr_img_hdr { |
| unsigned char magic[FASTBOOT_BOOT_MAGIC_SIZE]; |
| |
| unsigned int version; |
| unsigned int image_num; |
| struct { |
| unsigned char name[12]; |
| unsigned start; |
| unsigned size; |
| }img_info[FASTBOOT_BOOTLDR_IMG_NUM]; |
| }; |
| |
| #if defined(CONFIG_FASTBOOT) |
| /* A board specific test if u-boot should go into the fastboot command |
| ahead of the bootcmd |
| Returns 0 to continue with normal u-boot flow |
| Returns 1 to execute fastboot */ |
| extern int fastboot_preboot(void); |
| |
| /* Initizes the board specific fastboot |
| Returns 0 on success |
| Returns 1 on failure */ |
| extern int fastboot_init(struct cmd_fastboot_interface *interface); |
| |
| /* Cleans up the board specific fastboot */ |
| extern void fastboot_shutdown(void); |
| |
| /* |
| * Handles board specific usb protocol exchanges |
| * Returns 0 on success |
| * Returns 1 on disconnects, break out of loop |
| * Returns 2 if no USB activity detected |
| * Returns -1 on failure, unhandled usb requests and other error conditions |
| */ |
| extern int fastboot_poll(int sync); |
| |
| /* Is this high speed (2.0) or full speed (1.1) ? |
| Returns 0 on full speed |
| Returns 1 on high speed */ |
| extern int fastboot_is_highspeed(void); |
| |
| /* Return the size of the fifo */ |
| extern int fastboot_fifo_size(void); |
| |
| /* Send a status reply to the client app |
| buffer does not have to be null terminated. |
| buffer_size must be not be larger than what is returned by |
| fastboot_fifo_size |
| Returns 0 on success |
| Returns 1 on failure */ |
| extern int fastboot_tx_status(const char *buffer, unsigned int buffer_size, const u32 need_sync_flag); |
| |
| /* A board specific variable handler. |
| The size of the buffers is governed by the fastboot spec. |
| rx_buffer is at most 57 bytes |
| tx_buffer is at most 60 bytes |
| Returns 0 on success |
| Returns 1 on failure */ |
| extern int fastboot_getvar(const char *rx_buffer, char *tx_buffer); |
| |
| /* The Android-style flash handling */ |
| |
| /* tools to populate and query the partition table */ |
| extern void fastboot_flash_add_ptn(fastboot_ptentry *ptn); |
| extern fastboot_ptentry *fastboot_flash_find_ptn(const char *name); |
| extern fastboot_ptentry *fastboot_flash_get_ptn(unsigned n); |
| extern unsigned int fastboot_flash_get_ptn_count(void); |
| extern void fastboot_flash_dump_ptn(void); |
| |
| extern int fastboot_flash_init(void); |
| extern int fastboot_flash_erase(fastboot_ptentry *ptn); |
| extern int fastboot_flash_read_ext(fastboot_ptentry *ptn, |
| unsigned extra_per_page, unsigned offset, |
| void *data, unsigned bytes); |
| #define fastboot_flash_read(ptn, offset, data, bytes) \ |
| flash_read_ext(ptn, 0, offset, data, bytes) |
| extern int fastboot_flash_write(fastboot_ptentry *ptn, unsigned extra_per_page, |
| const void *data, unsigned bytes); |
| |
| extern void write_from_image(unsigned char *buffer, int flag); |
| extern int write_bootloader_img(unsigned char *buffer); |
| void fboot_usb_int_bulkout( u8 *buf, u32 cnt_byte ); |
| #else |
| |
| /* Stubs for when CONFIG_FASTBOOT is not defined */ |
| #define fastboot_preboot() 0 |
| #define fastboot_init(a) 1 |
| #define fastboot_shutdown() |
| #define fastboot_poll() 1 |
| #define fastboot_is_highspeed() 0 |
| #define fastboot_fifo_size() 0 |
| #define fastboot_tx_status(a, b, c) 1 |
| #define fastboot_getvar(a,b) 1 |
| |
| #define fastboot_flash_add_ptn(a) |
| #define fastboot_flash_find_ptn(a) NULL |
| #define fastboot_flash_get_ptn(a) NULL |
| #define fastboot_flash_get_ptn_count() 0 |
| #define fastboot_flash_dump_ptn() |
| #define fastboot_flash_init() |
| #define fastboot_flash_erase(a) 1 |
| #define fastboot_flash_read_ext(a, b, c, d, e) 0 |
| #define fastboot_flash_read(a, b, c, d, e) 0 |
| #define fastboot_flash_write(a, b, c, d) 0 |
| |
| #endif /* CONFIG_FASTBOOT */ |
| #endif /* FASTBOOT_H */ |
| |