doch_func.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.                   *
 *                                                                            *
 ******************************************************************************/
/*
 * $Log:   V:/PVCSDB/DiskOnChip/archives/Test for 7.x/src/H3/doch_func.h-arc  $
 * 
 *    Rev 1.19   Sep 11 2006 13:45:16   yaniv.iarovici
 * Legal header added
 * 
 *    Rev 1.18   Aug 09 2006 17:26:54   Polina.Marimont
 * initial for DOC Driver 1.0
 * 
 */

#ifndef DOCH_FUNC_H
#define DOCH_FUNC_H

#include "flcommon.h"
#include "doch_api.h"

#ifdef __cplusplus
extern "C" {
#endif

/*Get Info*/
DOCH_Error DOCHIdentifyDiskOnChipDevice(IOreq* ioreq);
DOCH_Error DOCHGetResetStatus(IOreq* ioreq);
DOCH_Error DOCHNotifyReset(IOreq* ioreq);
DOCH_Error DOCHNotifyPlatformResumed(IOreq* ioreq);
DOCH_Error DOCHPartitionInfo(IOreq* ioreq);
DOCH_Error DOCHSetDiskUserAttributes(IOreq* ioreq);
DOCH_Error DOCHGetDiskUserAttributes(IOreq* ioreq);
DOCH_Error DOCHGetConfigurationData(IOreq* ioreq);
DOCH_Error DOCHSetConfigurationData(IOreq* ioreq);

/*Media*/
DOCH_Error DOCHSetDefaultPartition(IOreq* ioreq);
DOCH_Error DOCHSetDataTransferMode(IOreq* ioreq);
DOCH_Error DOCHOptimizeMedia(IOreq* ioreq);
DOCH_Error DOCHDeletePartitions(IOreq* ioreq);
DOCH_Error DOCHAddPartition(IOreq* ioreq);
DOCH_Error DOCHUnformatDevice(IOreq* ioreq);
DOCH_Error DOCHWriteIPL(IOreq* ioreq);
DOCH_Error DOCHReadIPL(IOreq* ioreq);

/*IO*/
DOCH_Error DOCHReadPartitionSectors(IOreq* ioreq);
DOCH_Error DOCHWritePartitionSectors(IOreq* ioreq);
DOCH_Error DOCHWriteAndLock(IOreq* ioreq);
DOCH_Error DOCHWipeSectors(IOreq* ioreq);
DOCH_Error DOCHFreeSectors(IOreq* ioreq);
DOCH_Error DOCHPrepareForWrite(IOreq* ioreq);

/*Flexi-Flash*/
DOCH_Error DOCHWriteFlexiFast(IOreq* ioreq);
DOCH_Error DOCHWriteFlexiNormal(IOreq* ioreq);
DOCH_Error DOCHReWriteFlexiNormal(IOreq* ioreq);

/*Protection*/
DOCH_Error DOCHAccessPartWithPwd(IOreq* ioreq);
DOCH_Error DOCHDisablePartAccess(IOreq* ioreq);
DOCH_Error DOCHSetParitionProtection(IOreq* ioreq);

/*PKI*/
DOCH_Error DOCHSendHostPublicKey(IOreq* ioreq);
DOCH_Error DOCHReceiveDochPublicKey(IOreq* ioreq);
DOCH_Error DOCHVerifyHostKey(IOreq* ioreq);

/*Custom Parameters*/
DOCH_Error DOCHGetCustomParameter(IOreq* ioreq);
DOCH_Error DOCHSetCustomParameter(IOreq* ioreq);

/*Atomic Read/Write Sequence*/
DOCH_Error DOCHManageAtomicWriteSeq(IOreq* ioreq);

/*Algorithms*/
DOCH_Error DOCHReportSupportedAlgorithms(IOreq* ioreq);
DOCH_Error DOCHGetAlgorithmCapabilities(IOreq* ioreq);
DOCH_Error DOCHSetAlgorithmMode(IOreq* ioreq);

/*Hash*/
DOCH_Error DOCHAutoHashControl(IOreq* ioreq);
DOCH_Error DOCHReadCalculatedHash(IOreq* ioreq);
DOCH_Error DOCHWriteCalculatedHash(IOreq* ioreq);
DOCH_Error DOCHReadOriginalHash(IOreq* ioreq);
DOCH_Error DOCHWriteGivenHash(IOreq* ioreq);
DOCH_Error DOCHStartHashStreamCalculation(IOreq* ioreq);
DOCH_Error DOCHReadStopHashStreamCalc(IOreq* ioreq);
DOCH_Error DOCHReturnRandomNumbers(IOreq* ioreq);
DOCH_Error DOCHSetHashKey(IOreq* ioreq);

/*General*/
DOCH_Error DOCHSetParitionUserAttributes(IOreq* ioreq);
DOCH_Error DOCHGetParitionUserAttributes(IOreq* ioreq);
DOCH_Error DOCHSetPowerMode(IOreq* ioreq);
DOCH_Error DOCHGetPowerMode(IOreq* ioreq);
DOCH_Error DOCHConfigHW(IOreq* ioreq);
DOCH_Error DOCHRecoverFromPowerLoss(IOreq* ioreq);
DOCH_Error DOCHClearIRQ(IOreq* ioreq);
DOCH_Error DOCHGetPhysicalAddress(IOreq* ioreq);

#ifdef __cplusplus
}
#endif

#endif /*DOCH_FUNC_H*/