doch_api.h

H3 M-system NAND flash driver in Linux OS, M-DOC driver

/******************************************************************************
 *                                                                            *
 * Project: DOC Driver for Linux 2.4 Block device driver for mDOC H3  family  *
 * of devices under Linux kernel 2.4.                                         *
 *                                                                            *
 *   Version: 1.0                                                             *
 *   Email questions to: [e-mail]                               *
 *   Copyright (C) SanDisk IL Ltd. 1995 - 2007                                *
 *   SanDisk IL Ltd., 7 Atir Yeda Street, Kfar Saba 44425, Israel             *
 *                                                                            *
 ******************************************************************************
 *                                                                            *
 * This program is free software; you can redistribute it and/or modify it    *
 * under the terms of the GNU General Public License as published by the Free *
 * Software Foundation; either version 2 of the License, or any later version.*
 * This program is distributed in the hope that it will be useful, but WITHOUT*
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or      *
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for  *
 * more details, which is set forth in the readme.txt file.                   *
 * You should have received a copy of the GNU General Public License along    *
 * with this program; if not, write to the Free Software Foundation, Inc., 51 *
 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA                    *
 *                                                                            *
 * This License does not grant you any right to use the trademarks, service   *
 * marks or logos of SanDisk IL Ltd. or SanDisk Corporation.                  *
 * Subject to the foregoing, SanDisk IL Ltd., for itself and on behalf of its *
 * licensors, hereby reserves all intellectual property rights in the program,*
 * except for the rights expressly granted in this License.                   *
 *                                                                            *
 ******************************************************************************/
/***********************************************************************************/
/*																				   */
/*	Header file for doch_api module												   */ 
/*																				   */
/***********************************************************************************/

/*
 * $Log:   V:/PVCSDB/DiskOnChip/archives/Test for 7.x/src/H3/doch_api.h-arc  $
 * 
 *    Rev 1.31   Sep 11 2006 13:45:14   yaniv.iarovici
 * Legal header added
 * 
 *    Rev 1.30   Aug 09 2006 17:26:52   Polina.Marimont
 * initial for DOC Driver 1.0
 * 
 */

#ifndef _DOCH_API
#define _DOCH_API

#include "flcommon.h"
#include "flchkdef.h"
#include "_dochapi.h"
#include "blockdev.h"


/************************/
/*	Exported routines	*/
/************************/

#ifdef __cplusplus
extern "C" {
#endif

extern FLBoolean gDochIrqEnabled[];

DOCH_Error bdCallDOCH(int functionNo, IOreq *ioreq);
extern DOCH_Error doch_init_socket (int socketNo, DOCH_InitSocket);
extern DOCH_Error  doch_release_socket( int socketNo );

extern FLDword gDochAccessNanosec;


/*----------------------------------------------------------------------*/
/*                   f l B u i l d G e o m e t r y                      */
/*                                                                      */
/* Get C/H/S information of the disk according to number of sectors.    */
/*                                                                      */
/* Parameters:                                                          */
/*  capacity    : Number of Sectors in Volume                           */
/*  cylinders   : Pointer to Number of Cylinders                        */
/*  heads       : Pointer to Number of Heads                            */
/*  sectors     : Pointer to Number of Sectors per Track                */
/*  oldFormat   : True for one sector per culoster                      */
/*  wIrHandle   : Handle of the disk partition to check                 */
/*                                                                      */
/*----------------------------------------------------------------------*/
TFFS_DLL_API void NAMING_CONVENTION flBuildGeometry(FLDword capacity, FLDword FAR2 *cylinders,
         FLDword FAR2 *heads, FLDword FAR2 *sectors, FLBoolean oldFormat, FLWord wIrHandle);

/* Management routines */
DOCH_Error flDOCHAtaReset(FLByte socketNum);
DOCH_Error DochSDKInit(void);
void DochSDKExit(void);
DOCH_Error DochRegisterSocket(FLDword dwAddress);

/* User define component registration routine */
DOCH_Error flRegisterDochComponents(void);
/* Access layer registration routines */
DOCH_Error hal_init_nor (FLSNative  socketNo);
DOCH_Error hal_init_spi (FLSNative  socketNo);
DOCH_Error hal_init_sim (FLSNative  socketNo);
DOCH_Error hal_init_nor_noFunc (FLSNative  socketNo);
DOCH_Error hal_init_spi_noFunc (FLSNative  socketNo);
DOCH_Error hal_init_sim_noFunc (FLSNative  socketNo);
DOCH_Error hal_init_user_routines(FLSNative  socketNo, DOCH_BusAccess_routines accessPointerStruct);

void DOCH_SetBits(FLDword* var, FLDword mask, FLByte offset, FLDword val);

#ifdef __cplusplus
}
#endif

#endif /*_DOCH_API*/