1/******************************************************************************* 2Copyright (C) Marvell International Ltd. and its affiliates 3 4This software file (the "File") is owned and distributed by Marvell 5International Ltd. and/or its affiliates ("Marvell") under the following 6alternative licensing terms. Once you have made an election to distribute the 7File under one of the following license alternatives, please (i) delete this 8introductory statement regarding license alternatives, (ii) delete the two 9license alternatives that you have not elected to use and (iii) preserve the 10Marvell copyright notice above. 11 12******************************************************************************** 13Marvell Commercial License Option 14 15If you received this File from Marvell and you have entered into a commercial 16license agreement (a "Commercial License") with Marvell, the File is licensed 17to you under the terms of the applicable Commercial License. 18 19******************************************************************************** 20Marvell GPL License Option 21 22If you received this File from Marvell, you may opt to use, redistribute and/or 23modify this File in accordance with the terms and conditions of the General 24Public License Version 2, June 1991 (the "GPL License"), a copy of which is 25available along with the File in the license.txt file or by writing to the Free 26Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 or 27on the worldwide web at http://www.gnu.org/licenses/gpl.txt. 28 29THE FILE IS DISTRIBUTED AS-IS, WITHOUT WARRANTY OF ANY KIND, AND THE IMPLIED 30WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE ARE EXPRESSLY 31DISCLAIMED. The GPL License provides additional details about this warranty 32disclaimer. 33******************************************************************************** 34Marvell BSD License Option 35 36If you received this File from Marvell, you may opt to use, redistribute and/or 37modify this File under the following licensing terms. 38Redistribution and use in source and binary forms, with or without modification, 39are permitted provided that the following conditions are met: 40 41 * Redistributions of source code must retain the above copyright notice, 42 this list of conditions and the following disclaimer. 43 44 * Redistributions in binary form must reproduce the above copyright 45 notice, this list of conditions and the following disclaimer in the 46 documentation and/or other materials provided with the distribution. 47 48 * Neither the name of Marvell nor the names of its contributors may be 49 used to endorse or promote products derived from this software without 50 specific prior written permission. 51 52THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 53ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 54WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 55DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR 56ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 57(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 58LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON 59ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 60(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 61SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 62 63*******************************************************************************/ 64 65#ifndef __INCmvSFlashH 66#define __INCmvSFlashH 67 68#include "mvTypes.h" 69 70/* MCAROS */ 71#define MV_SFLASH_PAGE_ALLIGN_MASK(pgSz) (pgSz-1) 72#define MV_ARRAY_SIZE(a) ((sizeof(a)) / (sizeof(a[0]))) 73 74/* Constants */ 75#define MV_INVALID_DEVICE_NUMBER 0xFFFFFFFF 76/* 10 MHz is the minimum possible SPI frequency when tclk is set 200MHz*/ 77#define MV_SFLASH_BASIC_SPI_FREQ 10000000 78/* enumerations */ 79typedef enum 80{ 81 MV_WP_NONE, /* Unprotect the whole chip */ 82 MV_WP_UPR_1OF128, /* Write protect the upper 1/128 part */ 83 MV_WP_UPR_1OF64, /* Write protect the upper 1/64 part */ 84 MV_WP_UPR_1OF32, /* Write protect the upper 1/32 part */ 85 MV_WP_UPR_1OF16, /* Write protect the upper 1/16 part */ 86 MV_WP_UPR_1OF8, /* Write protect the upper 1/8 part */ 87 MV_WP_UPR_1OF4, /* Write protect the upper 1/4 part */ 88 MV_WP_UPR_1OF2, /* Write protect the upper 1/2 part */ 89 MV_WP_ALL /* Write protect the whole chip */ 90} MV_SFLASH_WP_REGION; 91 92/* Type Definitions */ 93typedef struct 94{ 95 MV_U8 opcdWREN; /* Write enable opcode */ 96 MV_U8 opcdWRDI; /* Write disable opcode */ 97 MV_U8 opcdRDID; /* Read ID opcode */ 98 MV_U8 opcdRDSR; /* Read Status Register opcode */ 99 MV_U8 opcdWRSR; /* Write Status register opcode */ 100 MV_U8 opcdREAD; /* Read opcode */ 101 MV_U8 opcdFSTRD; /* Fast Read opcode */ 102 MV_U8 opcdPP; /* Page program opcode */ 103 MV_U8 opcdSE; /* Sector erase opcode */ 104 MV_U8 opcdBE; /* Bulk erase opcode */ 105 MV_U8 opcdRES; /* Read electronic signature */ 106 MV_U8 opcdPwrSave; /* Go into power save mode */ 107 MV_U32 sectorSize; /* Size of each sector */ 108 MV_U32 sectorNumber; /* Number of sectors */ 109 MV_U32 pageSize; /* size of each page */ 110 const char * deviceModel; /* string with the device model */ 111 MV_U32 manufacturerId; /* The manufacturer ID */ 112 MV_U32 deviceId; /* Device ID */ 113 MV_U32 spiMaxFreq; /* The MAX frequency that can be used with the device */ 114 MV_U32 spiMaxFastFreq; /* The MAX frequency that can be used with the device for fast reads */ 115 MV_U32 spiFastRdDummyBytes; /* Number of dumy bytes to read before real data when working in fast read mode. */ 116} MV_SFLASH_DEVICE_PARAMS; 117 118typedef struct 119{ 120 MV_U32 baseAddr; /* Flash Base Address used in fast mode */ 121 MV_U8 manufacturerId; /* Manufacturer ID */ 122 MV_U16 deviceId; /* Device ID */ 123 MV_U32 sectorSize; /* Size of each sector - all the same */ 124 MV_U32 sectorNumber; /* Number of sectors */ 125 MV_U32 pageSize; /* Page size - affect allignment */ 126 MV_U32 index; /* index of the device in the sflash table (internal parameter) */ 127} MV_SFLASH_INFO; 128 129/* Function Prototypes */ 130/* Init */ 131MV_STATUS mvSFlashInit (MV_SFLASH_INFO * pFlinfo); 132 133/* erase */ 134MV_STATUS mvSFlashSectorErase (MV_SFLASH_INFO * pFlinfo, MV_U32 secNumber); 135MV_STATUS mvSFlashChipErase (MV_SFLASH_INFO * pFlinfo); 136 137/* Read */ 138MV_STATUS mvSFlashBlockRd (MV_SFLASH_INFO * pFlinfo, MV_U32 offset, 139 MV_U8* pReadBuff, MV_U32 buffSize); 140MV_STATUS mvSFlashFastBlockRd (MV_SFLASH_INFO * pFlinfo, MV_U32 offset, 141 MV_U8* pReadBuff, MV_U32 buffSize); 142 143/* write regardless of the page boundaries and size limit per Page program command */ 144MV_STATUS mvSFlashBlockWr (MV_SFLASH_INFO * pFlinfo, MV_U32 offset, 145 MV_U8* pWriteBuff, MV_U32 buffSize); 146/* Get IDs */ 147MV_STATUS mvSFlashIdGet (MV_SFLASH_INFO * pFlinfo, MV_U8* pManId, MV_U16* pDevId); 148 149/* Set and Get the Write Protection region - if the Status register is not locked */ 150MV_STATUS mvSFlashWpRegionSet (MV_SFLASH_INFO * pFlinfo, MV_SFLASH_WP_REGION wpRegion); 151MV_STATUS mvSFlashWpRegionGet (MV_SFLASH_INFO * pFlinfo, MV_SFLASH_WP_REGION * pWpRegion); 152 153/* Lock the status register for writing - W/Vpp pin should be low to take effect */ 154MV_STATUS mvSFlashStatRegLock (MV_SFLASH_INFO * pFlinfo, MV_BOOL srLock); 155 156/* Get the regions sizes */ 157MV_U32 mvSFlashSizeGet (MV_SFLASH_INFO * pFlinfo); 158 159/* Cause the falsh device to go into power save mode */ 160MV_STATUS mvSFlashPowerSaveEnter(MV_SFLASH_INFO * pFlinfo); 161MV_STATUS mvSFlashPowerSaveExit (MV_SFLASH_INFO * pFlinfo); 162 163/* Retreive the string with the device manufacturer and model */ 164const MV_8 * mvSFlashModelGet (MV_SFLASH_INFO * pFlinfo); 165 166#endif /* __INCmvSFlashH */ 167