www.pudn.com > SMSC USB2.0.zip > nand_media.h


/*============================================================================ 
  ____________________________________________________________________________ 
                                ______________________________________________ 
   SSSS  M   M          CCCC          Standard Microsystems Corporation 
  S      MM MM   SSSS  C                    Austin Design Center 
   SSS   M M M  S      C                 11000 N. Mopac Expressway 
      S  M   M   SSS   C                Stonelake Bldg. 6, Suite 500 
  SSSS   M   M      S   CCCC                Austin, Texas 78759 
                SSSS            ______________________________________________ 
  ____________________________________________________________________________ 
  Copyright(C) 1999, Standard Microsystems Corporation 
  All Rights Reserved. 
  This program code listing is proprietary to SMSC and may not be copied, 
  distributed, or used without a license to do so.  Such license may have 
  Limited or Restricted Rights. Please refer to the license for further 
  clarification. 
  ____________________________________________________________________________ 
  Notice: The program contained in this listing is a proprietary trade 
  secret of SMSC, Hauppauge, New York, and is copyrighted 
  under the United States Copyright Act of 1976 as an unpublished work, 
  pursuant to Section 104 and Section 408 of Title XVII of the United 
  States code. Unauthorized copying, adaption, distribution, use, or 
  display is prohibited by this law. 
  ____________________________________________________________________________ 
  Use, duplication, or disclosure by the Government is subject to 
  restrictions as set forth in subparagraph(c)(1)(ii) of the Rights 
  in Technical Data and Computer Software clause at DFARS 52.227-7013. 
  Contractor/Manufacturer is Standard Microsystems Corporation, 
  80 Arkay Drive, Hauppauge, New York, 1178-8847. 
  ____________________________________________________________________________ 
  ____________________________________________________________________________ 
  fmcdev.h - USB97210 device specific hardware interface definitions and 
             functions that are external to the MCU (ergo external to minimos). 
  ____________________________________________________________________________ 
  comments tbd 
  ____________________________________________________________________________ 
  Revision History 
  Date      Who  Comment 
  ________  ___  _____________________________________________________________ 
  09/17/01  cds  initial version 
  06/25/02  cds  incorporated boot block reading/writing for device usb config 
                 info 
  06/27/02  cds  - overrode media_set_read/write/erase_addr() to calculate  
                   chip/zone info from g_addr_zone 
                 - exported g_nand_num_chips and g_nand_zones_per_chip for  
                   tracking nand drive geometry  
  09/05/02  cds  removed unused constants in nand flash geometry section 
                 (max_chips and bytes_per_page) 
  11/21/02  ds   Modified nand_write_boot_flush to suit nand_int implementation. The prototype for nand_in_select_chip is  
                 added here.                 
============================================================================*/ 
 
#ifndef __nand_media_dot_h__ 
#define __nand_media_dot_h__ 
 
 
 
//------------------------------------------------------------------------------ 
// NAND Flash configuration. 
extern xdata uint8 g_nand_num_chips ;  
extern xdata uint8 g_nand_zones_per_chip ;      
extern xdata uint8 g_ix_media_nand ; 
 
//------------------------------------------------------------------------------ 
// NAND Flash media map geometry 
#define k_nand_max_zones_per_table  k_sm_max_zones_per_table 
#define k_nand_max_lb_per_zone      k_sm_max_lb_per_zone 
#define k_nand_max_pb_per_zone      k_sm_max_block_num 
 
//------------------------------------------------------------------------------ 
// NAND Flash media map table declarations 
//------------------------------------------------------------------------------ 
extern xdata uint16 _nand_log2phy[] ; 
extern xdata uint8  _nand_assign_map[] ; 
 
//------------------------------------------------------------------------------ 
// boot block access for storing VID/PID/Configuration info on the flash media 
//------------------------------------------------------------------------------ 
uint8 nand_boot_read(uint8 addr) reentrant;  
void  nand_boot_write(uint8 addr, uint8 datum) reentrant; 
t_result  nand_boot_write_flush() reentrant; 
void  nand_boot_seek() reentrant ; 
//Fn prototype from nand_int_media.c 
 
void nand_int_select_chip(uint8 addr_segment) reentrant; 
 
//+----------------------------------------------------------------------------- 
//------------------------------------------------------------------------------ 
t_result nand_erase_block(void) reentrant; 
#undef _v_media_erase_block 
#define _v_media_erase_block nand_erase_block 
 
//+----------------------------------------------------------------------------- 
//------------------------------------------------------------------------------ 
t_result  nand_read_sector(void) reentrant ;  
#undef _v_media_read_sector 
#define _v_media_read_sector nand_read_sector 
 
//+----------------------------------------------------------------------------- 
//------------------------------------------------------------------------------ 
t_result  nand_write_sector(void) reentrant ; 
#undef _v_media_write_sector 
#define _v_media_write_sector nand_write_sector 
 
//+----------------------------------------------------------------------------- 
//------------------------------------------------------------------------------ 
t_result nand_copy_sector(void) reentrant ; 
#undef _v_media_copy_sector 
#define _v_media_copy_sector nand_copy_sector 
 
//+----------------------------------------------------------------------------- 
//------------------------------------------------------------------------------ 
t_result  nand_read_extra_data(void) reentrant ; 
#undef _v_media_read_extra_data 
#define _v_media_read_extra_data nand_read_extra_data 
 
//+----------------------------------------------------------------------------- 
//------------------------------------------------------------------------------ 
t_result  nand_write_extra_data(void) reentrant ; 
#undef _v_media_write_extra_data 
#define _v_media_write_extra_data nand_write_extra_data 
 
//+----------------------------------------------------------------------------- 
// Name: 
//   media_set_read_addr() 
// 
// Declaration: 
//   t_result media_erase_card() reentrant 
//               media_set_read_addr 
// Purpose: 
//   set media-specific address from internal zone/rd_phy_blk/sector addres 
// 
// Arguments: 
//  TBD 
// 
// Return: 
//  k_success always 
// 
// Notes: 
//  TBD 
// 
// Since: 
//   fmc-1.0 
//------------------------------------------------------------------------------ 
t_result nand_set_read_addr() reentrant ; 
#undef _v_media_set_read_addr 
#define _v_media_set_read_addr nand_set_read_addr 
 
//+----------------------------------------------------------------------------- 
// Name: 
//   media_set_write_addr() 
// 
// Declaration: 
//   t_result media_set_write_addr() reentrant 
// 
// Purpose: 
//   set media-specific address from internal zone/wr_phy_blk/sector addres 
// 
// Arguments: 
//  TBD 
// 
// Return: 
//  k_success always 
// 
// Notes: 
//  TBD 
// 
// Since: 
//   fmc-1.0 
//------------------------------------------------------------------------------ 
t_result nand_set_write_addr() reentrant ; 
#undef _v_media_set_write_addr 
#define _v_media_set_write_addr nand_set_write_addr 
 
//+----------------------------------------------------------------------------- 
// Name: 
//   media_set_erase_addr() 
// 
// Declaration: 
//   t_result media_set_erase_addr() reentrant 
// 
// Purpose: 
//   set media-specific address from internal zone/wr_phy_blk 
// 
// Arguments: 
//  TBD 
// 
// Return: 
//  k_success always 
// 
// Notes: 
//  The block to be erased should be in g_addr_wr_phy_blk before this  
//  function is called 
// 
// Since: 
//   fmc-1.0 
//------------------------------------------------------------------------------ 
t_result nand_set_erase_addr() reentrant ; 
#undef _v_media_set_erase_addr 
#define _v_media_set_erase_addr nand_set_erase_addr 
 
 
//------------------------------------------------------------------------------ 
// virtual method table 
typedef uint8 t_nand_media_vtbl_ix ; 
typedef enum e_nand_media_vtbl_entry 
{ 
  k_nand_media_vtbl_sz = k_media_vtbl_sz 
} ; 
 
// sm class definition: 
#define _v_nand_media _v_sm_media 
 
// sm class vtable declaration & vtable size declaration 
extern code  _vtbl_decl(nand_media) ; 
 
// #endif // (k_log_lun_nand < k_max_log_lun) 
 
 
#else 
#error "warning: header included too many times!" 
#endif  // __nand_dot_h__ 
 
//---eof------------------------------------------------------------------------