nvm.h

00001 /*
00002  * Copyright (c) 2010, Mariano Alvira <mar@devl.org> and other contributors
00003  * to the MC1322x project (http://mc1322x.devl.org)
00004  * All rights reserved.
00005  *
00006  * Redistribution and use in source and binary forms, with or without
00007  * modification, are permitted provided that the following conditions
00008  * are met:
00009  * 1. Redistributions of source code must retain the above copyright
00010  *    notice, this list of conditions and the following disclaimer.
00011  * 2. Redistributions in binary form must reproduce the above copyright
00012  *    notice, this list of conditions and the following disclaimer in the
00013  *    documentation and/or other materials provided with the distribution.
00014  * 3. Neither the name of the Institute nor the names of its contributors
00015  *    may be used to endorse or promote products derived from this software
00016  *    without specific prior written permission.
00017  *
00018  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
00019  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00020  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00021  * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
00022  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00023  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
00024  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
00025  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00026  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
00027  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00028  * SUCH DAMAGE.
00029  *
00030  * This file is part of libmc1322x: see http://mc1322x.devl.org
00031  * for details. 
00032  *
00033  *
00034  */
00035 
00036 #ifndef NVM_H
00037 #define NVM_H
00038 
00039 #include <stdint.h>
00040 
00041 typedef enum
00042 {
00043         gNvmType_NoNvm_c,
00044         gNvmType_SST_c,
00045         gNvmType_ST_c,
00046         gNvmType_ATM_c,
00047         gNvmType_Max_c
00048 } nvmType_t;
00049 
00050 
00051 typedef enum
00052 {
00053         gNvmErrNoError_c = 0,
00054         gNvmErrInvalidInterface_c,
00055         gNvmErrInvalidNvmType_c,
00056         gNvmErrInvalidPointer_c,
00057         gNvmErrWriteProtect_c,
00058         gNvmErrVerifyError_c,
00059         gNvmErrAddressSpaceOverflow_c,
00060         gNvmErrBlankCheckError_c,
00061         gNvmErrRestrictedArea_c,
00062         gNvmErrMaxError_c
00063 } nvmErr_t;
00064 
00065 typedef enum
00066 {
00067         gNvmInternalInterface_c,
00068         gNvmExternalInterface_c,
00069         gNvmInterfaceMax_c
00070 } nvmInterface_t;
00071 
00072 /* ROM code seems to be THUMB */
00073 /* need to be in a THUMB block before calling them */
00074 extern nvmErr_t (*nvm_detect)(nvmInterface_t nvmInterface,nvmType_t* pNvmType);
00075 extern nvmErr_t (*nvm_read)(nvmInterface_t nvmInterface , nvmType_t nvmType , void *pDest, uint32_t address, uint32_t numBytes);
00076 extern nvmErr_t (*nvm_write)(nvmInterface_t nvmInterface, nvmType_t nvmType ,void *pSrc, uint32_t address, uint32_t numBytes);
00077 /* sector bit field selects which sector to erase */
00078 /* SST flash has 32 sectors 4096 bytes each */
00079 /* bit 0 is the first sector, bit 31 is the last */
00080 extern nvmErr_t (*nvm_erase)(nvmInterface_t nvmInterface, nvmType_t nvmType ,uint32_t sectorBitfield);
00081 extern void(*nvm_setsvar)(uint32_t zero_for_awesome);
00082 #endif //NVM_H