doxy & cleanup
This commit is contained in:
parent
cbe201fe6b
commit
d343941386
|
@ -23,6 +23,19 @@
|
|||
* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
|
||||
***************************************************************************/
|
||||
|
||||
/**
|
||||
* @file dsp5680xx_flash.c
|
||||
* @author Rodrigo L. Rosa <rodrigorosa.LG@gmail.com>
|
||||
* @date Thu Jun 9 18:21:58 2011
|
||||
*
|
||||
* @brief This file implements the basic functions to run flashing commands
|
||||
* from the TCL interface.
|
||||
* It allows the user to flash the Freescale 5680xx DSP.
|
||||
*
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
#ifdef HAVE_CONFIG_H
|
||||
#include "config.h"
|
||||
#endif
|
||||
|
@ -71,6 +84,15 @@ FLASH_BANK_COMMAND_HANDLER(dsp5680xx_flash_bank_command){
|
|||
return ERROR_OK;
|
||||
}
|
||||
|
||||
/**
|
||||
* A memory mapped register (PROT) holds information regarding sector protection.
|
||||
* Protection refers to undesired core access.
|
||||
* The value in this register is loaded from flash upon reset.
|
||||
*
|
||||
* @param bank
|
||||
*
|
||||
* @return
|
||||
*/
|
||||
static int dsp5680xx_flash_protect_check(struct flash_bank *bank){
|
||||
int retval = ERROR_OK;
|
||||
uint16_t protected = 0;
|
||||
|
@ -93,6 +115,18 @@ static int dsp5680xx_flash_protect_check(struct flash_bank *bank){
|
|||
return retval;
|
||||
}
|
||||
|
||||
/**
|
||||
* Protection funcionality is not implemented.
|
||||
* The current implementation applies/removes security on the chip.
|
||||
* The chip is effectively secured/unsecured after the first reset following the execution of this function.
|
||||
*
|
||||
* @param bank
|
||||
* @param set Apply or remove security on the chip.
|
||||
* @param first This parameter is ignored.
|
||||
* @param last This parameter is ignored.
|
||||
*
|
||||
* @return
|
||||
*/
|
||||
static int dsp5680xx_flash_protect(struct flash_bank *bank, int set, int first, int last){
|
||||
// This applies security to flash module after next reset, it does not actually apply protection (protection refers to undesired access from the core)
|
||||
int retval;
|
||||
|
@ -103,24 +137,16 @@ static int dsp5680xx_flash_protect(struct flash_bank *bank, int set, int first,
|
|||
return retval;
|
||||
}
|
||||
|
||||
/*
|
||||
static int dsp5680xx_write_block(struct flash_bank *bank, uint8_t *buffer, uint32_t offset, uint32_t count){
|
||||
LOG_USER("%s not implemented",__FUNCTION__);
|
||||
return ERROR_OK;
|
||||
}
|
||||
|
||||
static int dsp5680xx_write_single(struct flash_bank *bank, uint8_t *buffer, uint32_t offset, uint32_t count){
|
||||
LOG_USER("%s not implemented",__FUNCTION__);
|
||||
return ERROR_OK;
|
||||
}
|
||||
*/
|
||||
|
||||
//-- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
|
||||
//-- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
|
||||
// Flash stuff test
|
||||
//-- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
|
||||
//-- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
|
||||
|
||||
/**
|
||||
* The dsp5680xx use word addressing. The "/2" that appear in the following code are a workaround for the fact that OpenOCD uses byte addressing.
|
||||
*
|
||||
* @param bank
|
||||
* @param buffer Data to write to flash.
|
||||
* @param offset
|
||||
* @param count In bytes (2 bytes per address).
|
||||
*
|
||||
* @return
|
||||
*/
|
||||
static int dsp5680xx_flash_write(struct flash_bank *bank, uint8_t *buffer, uint32_t offset, uint32_t count){
|
||||
int retval;
|
||||
if((offset + count/2)>bank->size){
|
||||
|
@ -151,19 +177,17 @@ static int dsp5680xx_flash_info(struct flash_bank *bank, char *buf, int buf_size
|
|||
snprintf(buf, buf_size, "\ndsp5680xx flash driver info:\n - Currently only full erase/lock/unlock are implemented. \n - Call with bank==0 and sector 0 to 0.\n - Protect requires arp_init-reset to complete. \n - Before removing protection the master tap must be selected, and arp_init-reset is required to complete unlocking.");
|
||||
return ERROR_OK;
|
||||
}
|
||||
/*
|
||||
static int dsp5680xx_set_write_enable(struct target *target, int enable){
|
||||
LOG_USER("%s not implemented",__FUNCTION__);
|
||||
return ERROR_OK;
|
||||
}
|
||||
|
||||
|
||||
static int dsp5680xx_check_flash_completion(struct target* target, unsigned int timeout_ms){
|
||||
LOG_USER("%s not implemented",__FUNCTION__);
|
||||
return ERROR_OK;
|
||||
}
|
||||
*/
|
||||
|
||||
/**
|
||||
* The flash module (FM) on the dsp5680xx supports both individual sector and mass erase of the flash memory.
|
||||
* If this function is called with @first == @last == 0 or if @first is the first sector (#0) and @last is the last sector then the mass erase command is executed (much faster than erasing each sector individually).
|
||||
*
|
||||
* @param bank
|
||||
* @param first
|
||||
* @param last
|
||||
*
|
||||
* @return
|
||||
*/
|
||||
static int dsp5680xx_flash_erase(struct flash_bank * bank, int first, int last){
|
||||
int retval;
|
||||
retval = dsp5680xx_f_erase(bank->target, (uint32_t) first, (uint32_t) last);
|
||||
|
@ -177,6 +201,14 @@ static int dsp5680xx_flash_erase(struct flash_bank * bank, int first, int last){
|
|||
return retval;
|
||||
}
|
||||
|
||||
/**
|
||||
* The flash module (FM) on the dsp5680xx support a blank check function.
|
||||
* This function executes the FM's blank check functionality on each and every sector.
|
||||
*
|
||||
* @param bank
|
||||
*
|
||||
* @return
|
||||
*/
|
||||
static int dsp5680xx_flash_erase_check(struct flash_bank * bank){
|
||||
int retval = ERROR_OK;
|
||||
uint8_t erased = 0;
|
||||
|
|
File diff suppressed because it is too large
Load Diff
|
@ -25,6 +25,19 @@
|
|||
|
||||
#include <jtag/jtag.h>
|
||||
|
||||
/**
|
||||
* @file dsp5680xx.h
|
||||
* @author Rodrigo Rosa <rodrigorosa.LG@gmail.com>
|
||||
* @date Thu Jun 9 18:54:38 2011
|
||||
*
|
||||
* @brief Basic support for the 5680xx DSP from Freescale.
|
||||
* The chip has two taps in the JTAG chain, the Master tap and the Core tap.
|
||||
* In this code the Master tap is only used to unlock the flash memory by executing a JTAG instruction.
|
||||
*
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
#define S_FILE_DATA_OFFSET 0x200000
|
||||
|
||||
//----------------------------------------------------------------
|
||||
|
@ -160,6 +173,11 @@
|
|||
#define HFM_USTAT_MASK_BLANK 0x4
|
||||
#define HFM_USTAT_MASK_PVIOL_ACCER 0x30
|
||||
|
||||
/**
|
||||
* The value used on for the FM clock is important to prevent flashing errors and to prevent deterioration of the FM.
|
||||
* This value was calculated using a spreadsheet tool available on the Freescale website under FAQ 25464.
|
||||
*
|
||||
*/
|
||||
#define HFM_CLK_DEFAULT 0x40
|
||||
#define HFM_FLASH_BASE_ADDR 0x0
|
||||
#define HFM_SIZE_BYTES 0x4000 // bytes
|
||||
|
@ -168,10 +186,12 @@
|
|||
#define HFM_SECTOR_COUNT 0x20
|
||||
// A 16K block in pages of 256 words.
|
||||
|
||||
/**
|
||||
* Writing HFM_LOCK_FLASH to HFM_LOCK_ADDR_L and HFM_LOCK_ADDR_H will enable security on flash after the next reset.
|
||||
*/
|
||||
#define HFM_LOCK_FLASH 0xE70A
|
||||
#define HFM_LOCK_ADDR_L 0x1FF7
|
||||
#define HFM_LOCK_ADDR_H 0x1FF8
|
||||
// Writing HFM_LOCK_FLASH to HFM_LOCK_ADDR_L and HFM_LOCK_ADDR_H will enable security on flash after the next reset.
|
||||
//----------------------------------------------------------------
|
||||
|
||||
//----------------------------------------------------------------
|
||||
|
@ -203,12 +223,69 @@ static inline struct dsp5680xx_common *target_to_dsp5680xx(struct target *target
|
|||
return target->arch_info;
|
||||
}
|
||||
|
||||
/**
|
||||
* Writes to flash memory.
|
||||
* Does not check if flash is erased, it's up to the user to erase the flash before running this function.
|
||||
*
|
||||
* @param target
|
||||
* @param buffer
|
||||
* @param address
|
||||
* @param count In bytes.
|
||||
*
|
||||
* @return
|
||||
*/
|
||||
int dsp5680xx_f_wr(struct target * target, uint8_t *buffer, uint32_t address, uint32_t count);
|
||||
|
||||
/**
|
||||
* The FM has the funcionality of checking if the flash array is erased. This function executes it. It does not support individual sector analysis.
|
||||
*
|
||||
* @param target
|
||||
* @param erased
|
||||
* @param sector This parameter is ignored because the FM does not support checking if individual sectors are erased.
|
||||
*
|
||||
* @return
|
||||
*/
|
||||
int dsp5680xx_f_erase_check(struct target * target,uint8_t * erased, uint32_t sector);
|
||||
|
||||
/**
|
||||
* Erases either a sector or the complete flash array. If either the range first-last covers the complete array or if @first == 0 and @last == 0 then a mass erase command is executed on the FM. If not, then individual sectors are erased.
|
||||
*
|
||||
* @param target
|
||||
* @param first
|
||||
* @param last
|
||||
*
|
||||
* @return
|
||||
*/
|
||||
int dsp5680xx_f_erase(struct target * target, int first, int last);
|
||||
|
||||
/**
|
||||
* Reads the memory mapped protection register.
|
||||
*
|
||||
* @param target
|
||||
* @param protected Data read from the protection register.
|
||||
*
|
||||
* @return
|
||||
*/
|
||||
int dsp5680xx_f_protect_check(struct target * target, uint16_t * protected);
|
||||
|
||||
/**
|
||||
* Writes the flash security words with a specific value. The chip's security will be enabled after the first reset following the execution of this function.
|
||||
*
|
||||
* @param target
|
||||
*
|
||||
* @return
|
||||
*/
|
||||
int dsp5680xx_f_lock(struct target * target);
|
||||
|
||||
/**
|
||||
* Executes a mass erase command. The must be done from the Master tap.
|
||||
* It is up to the user to select the master tap (jtag tapenable dsp5680xx.chp) before running this function.
|
||||
* The flash array will be unsecured (and erased) after the first reset following the execution of this function.
|
||||
*
|
||||
* @param target
|
||||
*
|
||||
* @return
|
||||
*/
|
||||
int dsp5680xx_f_unlock(struct target * target);
|
||||
|
||||
#endif // dsp5680xx.h
|
||||
|
|
Loading…
Reference in New Issue