/****************************************Copyright (c)**************************************************
**                               Guangzou ZLG-MCU Development Co.,LTD.
**                                      graduate school
**                                 http://www.zlgmcu.com
**
**--------------File Info-------------------------------------------------------------------------------
** File Name:            MX25L1602Drv.h
** Last modified Date:   2007-04-25
** Last Version:         1.0
** Descriptions:         MX25L1602的操作函數
**
**------------------------------------------------------------------------------------------------------
** Created By:           Litiantian
** Created date:         2007-04-25
** Version:              1.0
** Descriptions:         First version
**
**------------------------------------------------------------------------------------------------------
** Modified by:     
** Modified date:   
** Version:         
** Descriptions:    
**
********************************************************************************************************/
#ifndef __F016BDRV_H 
#define __F016BDRV_H
#include "LPC11xx.h"

#define INT32U   uint32_t
#define INT16U   uint16_t
#define INT8U    uint8_t

/*
 * 定義操作MX25L1602所需的數據 
 */
enum PARAMETER_TYPE {Invalid};                                          /* 定義1個常量,代表無效參數     */
enum OptResult{ERROR,OK};

typedef enum ERTYPE{Sec1,Sec8,Sec16,Chip} ErType;  
typedef enum IDTYPE{Manu_ID,Dev_ID,Jedec_ID} idtype;

#define MAX_ADDR       0x1FFFFF                                         /* 定義芯片內部最大地址         */
#define SEC_MAX        512                                              /* 定義最大扇區號               */
#define SEC_SIZE       0x1000                                           /* 扇區大小                     */
/* 
 * 宏,用于定義SPI_CS的片選引腳
 */
#define SPI_CS        (1 << 2)                                          /* P0.2口為25VF016B的片選，     */
                                                                        /* 該腳為低時，SST25VF016B被使能*/


/*********************************************************************************************************
** 函數名稱：SPIInit
** 功能描述：初始化MCU與SST25VF016B芯片的控制和通訊接口
** 輸入參數：無
** 輸入參數：無
** 返 回 值：無
*********************************************************************************************************/
extern  void  SSP_Init(void);

/*********************************************************************************************************
** 函數名稱:MX25L1602_RD
** 函數功能:MX25L1602的讀函數,可選擇讀ID和讀數據操作
** 輸入參數:
**          uint32 Dst：目標地址,范圍 0x0 - MAX_ADDR（MAX_ADDR = 0x1FFFFF）
**          uint32 NByte:  要讀取的數據字節數
**          uint8* RcvBufPt:接收緩存的指針
** 輸出參數:操作成功則返回OK,失敗則返回ERROR
** 特殊說明:若某功能下,某一入口參數無效,可在該入口參數處填Invalid，該參數將被忽略
**********************************************************************************************************/
extern   INT8U MX25L1602_RD(INT32U Dst, INT32U NByte,INT8U* RcvBufPt);

/*********************************************************************************************************
** 函數名稱:MX25L1602_RdID
** 函數功能:MX25L1602的讀ID函數,可選擇讀ID和讀數據操作
** 輸入參數:
**          idtype IDType:ID類型。用戶可在Jedec_ID,Dev_ID,Manu_ID三者里選擇
**          uint32* RcvbufPt:存儲ID變量的指針
** 輸出參數:操作成功則返回OK,失敗則返回ERROR
** 特殊說明:若填入的參數不符合要求，則返回ERROR
*********************************************************************************************************/
extern   INT8U MX25L1602_RdID(idtype IDType, INT32U* RcvbufPt);

/*********************************************************************************************************
** 函數名稱:SSTF016B_WR
** 函數功能:SST25VF016B的寫函數，可寫1個和多個數據到指定地址
** 輸入參數:
**         uint32 Dst：目標地址,范圍 0x0 - MAX_ADDR（MAX_ADDR = 0x1FFFFF）
**         uint8* SndbufPt:發送緩存區指針
**         uint32 NByte:要寫的數據字節數
** 輸出參數:操作成功則返回OK,失敗則返回ERROR
** 特殊說明:若某功能下,某一入口參數無效,可在該入口參數處填Invalid，該參數將被忽略
*********************************************************************************************************/
extern   INT8U MX25L1602_WR(INT32U Dst,INT8U* SndbufPt,INT32U NByte);

/********************************************************************************************************
** 函數名稱:SSTF016B_Erase
** 函數功能:根據指定的扇區號選取最高效的算法擦除
** 輸入參數:
**          uint32 sec1：起始扇區號,范圍(0~499)
**          uint32 sec2：終止扇區號,范圍(0~499)
** 輸出參數:操作成功則返回OK,失敗則返回ERROR
*********************************************************************************************************/
extern  INT8U MX25L1602_Erase(INT32U sec1, INT32U sec2);


#endif

/********************************************************************************************************
** End Of File
*********************************************************************************************************/