flash.h

Go to the documentation of this file.

/* Embedded XINU, Copyright (C) 2007.  All rights reserved. */


#ifndef _FLASH_H_
#define _FLASH_H_

/* Disk variables */
#define MAX_LIVE_BLOCKS 8   
#define FLASH_BLK_SIZE  512 
#define FLASH_BLOCK_FREE  0 
#define FLASH_BLOCK_CLEAN 1 
#define FLASH_BLOCK_DIRTY 2 
/* Important disk block sections */
#define CFE_MIN_BLOCK    0x0000 
#define CFE_MAX_BLOCK    0x01FF 
#define KERNEL_MIN_BLOCK 0x0200 
#define KERNEL_MAX_BLOCK 0x03FF 
#define NVRAM_MIN_BLOCK  0x1FC0 
#define NVRAM_MAX_BLOCK  0x1FFF 
/* Flash control switch values */
#define FLASH_BLOCK_SIZE 0x0000 
#define FLASH_N_BLOCKS   0x0001 
#define FLASH_SYNC       0x0002 
/* Flash variables */
#define FLASH_WIDEMODE 1
#define MAX_REGIONS    8

/* TRX variables */
#define TRX_MAGIC   0x30524448

/* Structures */
struct trx_header
{
    uint32 magic;                 
    uint32 len;                   
    uint32 crc;                   
    uint32 flags_vers;             
    uint32 offsets[3];            
};

/* File structure */
struct file
{
    uint32 len;
    char *name;
    void *data;
};

struct flash_region
{
    uint32 nblocks;              
    uint32 block_size;           
    uint32 region_start;         
    uint32 region_size;          
};

struct flash_block
{
    uint32 start_pos;            
    uint32 size;                 
    byte state;                
    void *buffer;               
};

struct flash
{
    struct dentry *device;             
    byte commands;             
    uint32 base;                 
    sid32   lock;             
    uint32 size;                 
    byte mode;                 
    uint16 nregions;            
    struct flash_region regions[MAX_REGIONS];     
    uint32 log_size;             
    uint32 nlog_blocks;          
    struct flash_block erase_blocks[MAX_LIVE_BLOCKS];
    byte curr_block;           
};

extern struct flash_block bad_block;

/*
 * Common Flash Interface Query commands and macros
 */

/* put/get 8-bits commands for CFI */
#define CFI_PUT_8(addr,offset,cmd) \
    *((volatile unsigned char *)((addr)+((offset)<<FLASH_WIDEMODE)))=(cmd)
#define CFI_GET_8(addr,offset) \
    *((volatile unsigned char *)((addr)+((offset)<<FLASH_WIDEMODE)))

/* commands for data gathering */
#define CFI_QUERY_ADDR    0x55
#define CFI_QUERY_MODE    0x98
#define CFI_QUERY_EXIT    0xFF

#define CFI_MANUFACTURER  0x00
#define CFI_DEVICE        0x01
#define CFI_SIGNATURE     0x10
#define CFI_QUERY_STRING  0x10
#define CFI_COMMAND_SET   0x13
#define CFI_DEV_SIZE      0x27
#define CFI_DEV_INTERFACE 0x28
#define CFI_MAX_BUFFER    0x2A
#define CFI_REGION_COUNT  0x2C
#define CFI_REGION_TAB    0x2D

/* Known command sets (from CFI publication 100) */
#define FLASH_INTEL_ECS   0x0001
#define FLASH_AMD_SCS     0x0002
#define FLASH_INTEL_SCS   0x0003
#define FLASH_AMD_ECS     0x0004
#define FLASH_MTSU_SCS    0x0100
#define FLASH_MTSU_ECS    0x0101

/*
 * Intel Flash specifc commands and macros
 */

/* put/get 8-bits commands for Intel */
#define INTEL_PUT_8(addr,byte) \
    *((volatile unsigned char *)((unsigned int)(addr)))=(byte)
#define INTEL_GET_8(addr) \
    *((volatile unsigned char *)((unsigned int)(addr)))

/* put/get 8-bits commands for AMD */
#define AMD_PUT_8(addr,byte) \
    *((volatile unsigned char *)((unsigned int)(addr)))=(byte)
#define AMD_GET_8(addr) \
    *((volatile unsigned char *)((unsigned int)(addr)))

/* put/get 16-bits commands for Intel */
#define INTEL_PUT_16(addr,word) \
    *((volatile unsigned int16 *)((unsigned int)(addr)))=(word)
#define INTEL_GET_16(addr) \
    *((volatile unsigned int16 *)((unsigned int)(addr)))

/* put/get 16-bits commands for AMD */
#define AMD_PUT_16(addr,word) \
    *((volatile unsigned int16 *)((unsigned int)(addr)))=(word)
#define AMD_GET_16(addr) \
        *((volatile unsigned int16 *)((unsigned int)(addr)))


/* Intel command codes                                               */
#define INTEL_READ     0xFF   
#define INTEL_PROGRAM  0x40   
#define INTEL_ERASE    0x20   
#define INTEL_CONFIRM  0xD0   
#define INTEL_RESUME   0xD0   
#define INTEL_UNLOCK   0xD0   
#define INTEL_SUSPEND  0xB0   
#define INTEL_READ_SR  0x70   
#define INTEL_CLR_SR   0x50   
#define INTEL_READ_ID  0x90   
#define INTEL_BLOCKMOD 0x60   
#define INTEL_LOCK     0x01   
#define INTEL_LOCKDOWN 0x2F   
/* AMD Command Codes                                                 */
#define AMD_UNLOCK_CYCLE1   0xAA    
#define AMD_UNLOCK_CYCLE2   0x55    
#define AMD_ERASE_CYCLE3    0x80    
#define AMD_ERASE_CYCLE6    0x30    
#define AMD_PROGRAM_CYCLE3  0xA0    
#define AMD_RESET           0xF0    
#define AMD_READ            0xFF    
#define AMD_BLOCKMOD        0x60    
#define AMD_LOCK            0x01    
#define AMD_CLR_SR          0x50    
/* AMD                                                               */
#define AMD_REG_CYCLE1  0x555      
#define AMD_REG_CYCLE2  0x2AA      
#define AMD_SR_WSMS     0x001      
/* Intel status register offsets                                     */
#define INTEL_SR_WSMS  7      
#define INTEL_SR_ESS   6      
#define INTEL_SR_ES    5      
#define INTEL_SR_PS    4      
#define INTEL_SR_PSS   2      
#define INTEL_SR_BLS   1      
/* Intel identifier register offsets                                 */
#define INTEL_ID_MFG   0x00   
#define INTEL_ID_DEV   0x02   
#define INTEL_ID_BLS   0x04   
/* Intel block lock constants                                        */
#define INTEL_S_LOCK   0x01   
#define INTEL_H_LOCK   0x02   
/* AMD block lock constants                                        */
#define AMD_S_LOCK   0x01   
#define AMD_H_LOCK   0x02   
/* flashControl constants                                            */
#define FLASH_BLOCK    0x00 
#define FLASH_LOGBLOCK 0x01 
/* physicalLock commands                                             */
#define FLASH_STATUS   0x0000 
#define FLASH_MODE     0x0001 
#define FLASH_LOCKED   0x0010 
#define FLASH_LOCK     0x0011 
#define FLASH_UNLOCK   0x0012 
#define FLASH_LOCKDOWN 0x0013 
#define FLASH_ERASE_PREP 0x0014 
#define FLASH_RESET    0x0015

extern struct flash flashtab[];

/* Prototypes for flash function calls */
devcall flashInit(struct dentry *);
devcall flashOpen(struct dentry *, va_list);
devcall flashRead(struct dentry *, byte *, uint32);
devcall flashWrite(struct dentry *, byte *, uint32);
devcall flashSeek(struct dentry *, uint32);
devcall flashControl(struct dentry *, uint16, int32, int32);
devcall flashClose(struct dentry *);

/* Prototypes for the Logical Flash Interface */
devcall logicalRead(struct flash *, byte *, uint32);
devcall logicalWrite(struct flash *, byte *, uint32);
struct flash_block logicalMap(struct flash *, uint32);

/* Prototypes for Physical Flash functions */
devcall physicalRead(struct flash *, struct flash_block *);
devcall physicalWrite(struct flash *, struct flash_block *);
devcall physicalErase(struct flash *, struct flash_block *);
devcall physicalControl(struct flash *, struct flash_block *, byte,
                        uint32);
devcall physicalIntelRead(struct flash *, struct flash_block *);
devcall physicalIntelWrite(struct flash *, struct flash_block *);
devcall physicalIntelErase(struct flash *, struct flash_block *);
devcall physicalIntelControl(struct flash *, struct flash_block *, byte,
                             uint32);
devcall physicalAMDRead(struct flash *, struct flash_block *);

/* Prototypes for changing OS in flash memory */
bool validateTrx(struct file *);

/* File function prototypes */
syscall printFileStats(struct file *, char *, char *, int, int);
syscall freeFile(struct file *);

#endif                          /* _FLASH_H_ */