burn_lib.h.svn-base

vc环境下编译的一个对USB设备进行烧录的驱动程序

/**
 * @file burn_lib.h
 * @brief API of burn lib 
 * Copyright (C) 2007 Anyka (GuangZhou) Software Technology Co., Ltd.
 * @author Zhijun Liao
 * @date 2007-08-13
 * @version 1.0
 * @ref 
 */



#ifndef __BURN_LIB_H__
#define __BURN_LIB_H__

#include "burn.h"



/**
 * @brief   config nandboot parameter before download it into nandflash.
 *
 * @author  Zhijun Liao
 * @date    2007-08-13
 * @param   [in/out] nandboot: nandboot data.
 * @param   [in] config: config data which contains CHIP type and RAM information
 * @param   [in] nandinfo: nandflash information .
 * @return  
 */
void config_nandboot_parameter(BYTE *nandboot, configuration &config, T_NAND_PHY_INFO &nandinfo);


/**
 * @brief   write some information to nandflash for futher use.
 *
 * @author  Zhijun Liao
 * @date    2007-08-13
 * @param   [in] id: id of this burn process
 * @param   [out] bDownEncryptFile: 
 * @param   [out] encrypt_file: 
 * @param   [in] usb: M3USB object.
 * @return  bool
 */
bool set_infor_trans(int id, bool &bDownEncryptFile, 
					download_file &encrypt_file, CM3USBC &usb);


/**
 * @brief   set register through usb
 *
 * @author  Zhijun Liao
 * @date    2007-08-13
 * @param   [in] address: register address.
 * @param   [in] value: register value.
 * @param   [in] usb: M3USB object.
 * @return  bool
 */
bool set_reg_usb(int address, int value, CM3USBC &usb);

/**
 * @brief   set register through com
 *
 * @author  Zhijun Liao
 * @date    2007-08-13
 * @param   [in] address: register address.
 * @param   [in] value: register value.
 * @param   [in] com: thread com object.
 * @return  bool
 */
bool set_reg_com(int address, int value, _thread_com &com);

/**
 * @brief   set registers through usb
 *
 * @author  Zhijun Liao
 * @date    2007-08-13
 * @param   [in] config: config data which contains registers to set and other information
 * @param   [in] usb: M3USB object.
 * @return  bool
 */
bool set_registers_usb(configuration &config, CM3USBC &usb);

/**
 * @brief   set registers through com
 *
 * @author  Zhijun Liao
 * @date    2007-08-13
 * @param   [in] config: config data which contains registers to set and other information
 * @param   [in] com: thread com object.
 * @return  bool
 */
bool set_registers_com(configuration &config, _thread_com &com);

/**
 * @brief   run producer through usb
 *
 * @author  Zhijun Liao
 * @date    2007-08-13
 * @param   [in] go_address: RAM address that producer downloaded to
 * @param   [in] usb: M3USB object.
 * @return  bool
 */
bool command_go_usb(UINT go_address, CM3USBC &usb);

/**
 * @brief   run producer through com
 *
 * @author  Zhijun Liao
 * @date    2007-08-13
 * @param   [in] go_address: RAM address that producer downloaded to
 * @param   [in] com: thread com object.
 * @return  bool
 */
bool command_go_com(UINT go_address, _thread_com &com);

/**
 * @brief   download producer through usb
 *
 * @author  Zhijun Liao
 * @date    2007-08-13
 * @param   [in] pc_path: the path of producer.bin
 * @param   [in] address: RAM address that producer downloaded to
 * @param   [in] usb: M3USB object.
 * @return  bool
 */
bool command_download_usb(char *pc_path, UINT address, CM3USBC &usb);

/**
 * @brief   download producer through com
 *
 * @author  Zhijun Liao
 * @date    2007-08-13
 * @param   [in] pc_path: the path of producer.bin
 * @param   [in] address: RAM address that producer downloaded to
 * @param   [in] com: thread com object.
 * @return  bool
 */
bool command_download_com(char *pc_path, UINT address, _thread_com &com);

#endif