|
STM324x9I_EVAL BSP User Manual
|
stm324x9i_eval_eeprom.c
Go to the documentation of this file.
00001 /** 00002 ****************************************************************************** 00003 * @file stm324x9i_eval_eeprom.c 00004 * @author MCD Application Team 00005 * @version V2.2.2 00006 * @date 13-January-2016 00007 * @brief This file provides a set of functions needed to manage an I2C M24LR64 00008 * EEPROM memory. 00009 * To be able to use this driver, the switch EE_M24LR64 must be defined 00010 * in your toolchain compiler preprocessor 00011 * 00012 * =================================================================== 00013 * Notes: 00014 * - This driver is intended for STM32F4xx families devices only. 00015 * - The I2C EEPROM memory (M24LR64) is available on separate daughter 00016 * board ANT7-M24LR-A, which is not provided with the STM324x9I_EVAL 00017 * board. 00018 * To use this driver you have to connect the ANT7-M24LR-A to CN3 00019 * connector of STM324x9I_EVAL board. 00020 * =================================================================== 00021 * 00022 * It implements a high level communication layer for read and write 00023 * from/to this memory. The needed STM32F4xx hardware resources (I2C and 00024 * GPIO) are defined in stm324x9i_eval.h file, and the initialization is 00025 * performed in EEPROM_IO_Init() function declared in stm324x9i_eval.c 00026 * file. 00027 * You can easily tailor this driver to any other development board, 00028 * by just adapting the defines for hardware resources and 00029 * EEPROM_IO_Init() function. 00030 * 00031 * @note In this driver, basic read and write functions (BSP_EEPROM_ReadBuffer() 00032 * and BSP_EEPROM_WritePage()) use DMA mode to perform the data 00033 * transfer to/from EEPROM memory. 00034 * 00035 * @note Regarding BSP_EEPROM_WritePage(), it is a optimized function to perform 00036 * small write (less than 1 page) BUT The number of bytes (combined to write start address) must not 00037 * cross the EEPROM page boundary. This function can only write into 00038 * the boundaries of an EEPROM page. 00039 * This function doesn't check on boundaries condition (in this driver 00040 * the function BSP_EEPROM_WriteBuffer() which calls BSP_EEPROM_WritePage() is 00041 * responsible of checking on Page boundaries). 00042 * 00043 * 00044 * +-----------------------------------------------------------------+ 00045 * | Pin assignment for M24LR64 EEPROM | 00046 * +---------------------------------------+-----------+-------------+ 00047 * | STM32F4xx I2C Pins | EEPROM | Pin | 00048 * +---------------------------------------+-----------+-------------+ 00049 * | . | E0(GND) | 1 (0V) | 00050 * | . | AC0 | 2 | 00051 * | . | AC1 | 3 | 00052 * | . | VSS | 4 (0V) | 00053 * | SDA | SDA | 5 | 00054 * | SCL | SCL | 6 | 00055 * | . | E1(GND) | 7 (0V) | 00056 * | . | VDD | 8 (3.3V) | 00057 * +---------------------------------------+-----------+-------------+ 00058 * 00059 ****************************************************************************** 00060 * @attention 00061 * 00062 * <h2><center>© COPYRIGHT(c) 2015 STMicroelectronics</center></h2> 00063 * 00064 * Redistribution and use in source and binary forms, with or without modification, 00065 * are permitted provided that the following conditions are met: 00066 * 1. Redistributions of source code must retain the above copyright notice, 00067 * this list of conditions and the following disclaimer. 00068 * 2. Redistributions in binary form must reproduce the above copyright notice, 00069 * this list of conditions and the following disclaimer in the documentation 00070 * and/or other materials provided with the distribution. 00071 * 3. Neither the name of STMicroelectronics nor the names of its contributors 00072 * may be used to endorse or promote products derived from this software 00073 * without specific prior written permission. 00074 * 00075 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 00076 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 00077 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 00078 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 00079 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 00080 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 00081 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 00082 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 00083 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 00084 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 00085 * 00086 ****************************************************************************** 00087 */ 00088 /* Includes ------------------------------------------------------------------*/ 00089 #include "stm324x9i_eval_eeprom.h" 00090 00091 /** @addtogroup BSP 00092 * @{ 00093 */ 00094 00095 /** @addtogroup STM324x9I_EVAL 00096 * @{ 00097 */ 00098 00099 /** @defgroup STM324x9I_EVAL_EEPROM STM324x9I EVAL EEPROM 00100 * @brief This file includes the I2C EEPROM driver of STM324x9I-EVAL evaluation board. 00101 * @{ 00102 */ 00103 00104 /** @defgroup STM324x9I_EVAL_EEPROM_Private_Types STM324x9I EVAL EEPROM Private Types 00105 * @{ 00106 */ 00107 /** 00108 * @} 00109 */ 00110 00111 /** @defgroup STM324x9I_EVAL_EEPROM_Private_Defines STM324x9I EVAL EEPROM Private Defines 00112 * @{ 00113 */ 00114 /** 00115 * @} 00116 */ 00117 00118 /** @defgroup STM324x9I_EVAL_EEPROM_Private_Macros STM324x9I EVAL EEPROM Private Macros 00119 * @{ 00120 */ 00121 /** 00122 * @} 00123 */ 00124 00125 /** @defgroup STM324x9I_EVAL_EEPROM_Private_Variables STM324x9I EVAL EEPROM Private Variables 00126 * @{ 00127 */ 00128 __IO uint16_t EEPROMAddress = 0; 00129 __IO uint32_t EEPROMTimeout = EEPROM_READ_TIMEOUT; 00130 __IO uint16_t EEPROMDataRead; 00131 __IO uint8_t EEPROMDataWrite; 00132 /** 00133 * @} 00134 */ 00135 00136 /** @defgroup STM324x9I_EVAL_EEPROM_Private_Function_Prototypes STM324x9I EVAL EEPROM Private Function Prototypes 00137 * @{ 00138 */ 00139 /** 00140 * @} 00141 */ 00142 00143 /** @defgroup STM324x9I_EVAL_EEPROM_Private_Functions STM324x9I EVAL EEPROM Private Functions 00144 * @{ 00145 */ 00146 00147 /** 00148 * @brief Initializes peripherals used by the I2C EEPROM driver. 00149 * 00150 * @note There are 2 different versions of M24LR64 (A01 & A02). 00151 * Then try to connect on 1st one (EEPROM_I2C_ADDRESS_A01) 00152 * and if problem, check the 2nd one (EEPROM_I2C_ADDRESS_A02) 00153 * @retval EEPROM_OK (0) if operation is correctly performed, else return value 00154 * different from EEPROM_OK (0) 00155 */ 00156 uint32_t BSP_EEPROM_Init(void) 00157 { 00158 /* I2C Initialization */ 00159 EEPROM_IO_Init(); 00160 00161 /* Select the EEPROM address for A01 and check if OK */ 00162 EEPROMAddress = EEPROM_I2C_ADDRESS_A01; 00163 if(EEPROM_IO_IsDeviceReady(EEPROMAddress, EEPROM_MAX_TRIALS) != HAL_OK) 00164 { 00165 /* Select the EEPROM address for A02 and check if OK */ 00166 EEPROMAddress = EEPROM_I2C_ADDRESS_A02; 00167 if(EEPROM_IO_IsDeviceReady(EEPROMAddress, EEPROM_MAX_TRIALS) != HAL_OK) 00168 { 00169 return EEPROM_FAIL; 00170 } 00171 } 00172 return EEPROM_OK; 00173 } 00174 00175 /** 00176 * @brief Reads a block of data from the EEPROM. 00177 * @param pBuffer: pointer to the buffer that receives the data read from 00178 * the EEPROM. 00179 * @param ReadAddr: EEPROM's internal address to start reading from. 00180 * @param NumByteToRead: pointer to the variable holding number of bytes to 00181 * be read from the EEPROM. 00182 * 00183 * @note The variable pointed by NumByteToRead is reset to 0 when all the 00184 * data are read from the EEPROM. Application should monitor this 00185 * variable in order know when the transfer is complete. 00186 * 00187 * @retval EEPROM_OK (0) if operation is correctly performed, else return value 00188 * different from EEPROM_OK (0) or the timeout user callback. 00189 */ 00190 uint32_t BSP_EEPROM_ReadBuffer(uint8_t* pBuffer, uint16_t ReadAddr, uint16_t* NumByteToRead) 00191 { 00192 uint32_t buffersize = *NumByteToRead; 00193 00194 /* Set the pointer to the Number of data to be read. This pointer will be used 00195 by the DMA Transfer Completer interrupt Handler in order to reset the 00196 variable to 0. User should check on this variable in order to know if the 00197 DMA transfer has been complete or not. */ 00198 EEPROMDataRead = *NumByteToRead; 00199 00200 if(EEPROM_IO_ReadData(EEPROMAddress, ReadAddr, pBuffer, buffersize) != HAL_OK) 00201 { 00202 BSP_EEPROM_TIMEOUT_UserCallback(); 00203 return EEPROM_FAIL; 00204 } 00205 00206 /* If all operations OK, return EEPROM_OK (0) */ 00207 return EEPROM_OK; 00208 } 00209 00210 /** 00211 * @brief Writes more than one byte to the EEPROM with a single WRITE cycle. 00212 * 00213 * @note The number of bytes (combined to write start address) must not 00214 * cross the EEPROM page boundary. This function can only write into 00215 * the boundaries of an EEPROM page. 00216 * This function doesn't check on boundaries condition (in this driver 00217 * the function BSP_EEPROM_WriteBuffer() which calls BSP_EEPROM_WritePage() is 00218 * responsible of checking on Page boundaries). 00219 * 00220 * @param pBuffer: pointer to the buffer containing the data to be written to 00221 * the EEPROM. 00222 * @param WriteAddr: EEPROM's internal address to write to. 00223 * @param NumByteToWrite: pointer to the variable holding number of bytes to 00224 * be written into the EEPROM. 00225 * 00226 * @note The variable pointed by NumByteToWrite is reset to 0 when all the 00227 * data are written to the EEPROM. Application should monitor this 00228 * variable in order know when the transfer is complete. 00229 * 00230 * @note This function just configure the communication and enable the DMA 00231 * channel to transfer data. Meanwhile, the user application may perform 00232 * other tasks in parallel. 00233 * 00234 * @retval EEPROM_OK (0) if operation is correctly performed, else return value 00235 * different from EEPROM_OK (0) or the timeout user callback. 00236 */ 00237 uint32_t BSP_EEPROM_WritePage(uint8_t* pBuffer, uint16_t WriteAddr, uint8_t* NumByteToWrite) 00238 { 00239 uint32_t buffersize = *NumByteToWrite; 00240 uint32_t status = EEPROM_OK; 00241 00242 /* Set the pointer to the Number of data to be written. This pointer will be used 00243 by the DMA Transfer Completer interrupt Handler in order to reset the 00244 variable to 0. User should check on this variable in order to know if the 00245 DMA transfer has been complete or not. */ 00246 EEPROMDataWrite = *NumByteToWrite; 00247 00248 if(EEPROM_IO_WriteData(EEPROMAddress, WriteAddr, pBuffer, buffersize) != HAL_OK) 00249 { 00250 BSP_EEPROM_TIMEOUT_UserCallback(); 00251 status = EEPROM_FAIL; 00252 } 00253 00254 if(BSP_EEPROM_WaitEepromStandbyState() != EEPROM_OK) 00255 { 00256 return EEPROM_FAIL; 00257 } 00258 00259 /* If all operations OK, return EEPROM_OK (0) */ 00260 return status; 00261 } 00262 00263 /** 00264 * @brief Writes buffer of data to the I2C EEPROM. 00265 * @param pBuffer: pointer to the buffer containing the data to be written 00266 * to the EEPROM. 00267 * @param WriteAddr: EEPROM's internal address to write to. 00268 * @param NumByteToWrite: number of bytes to write to the EEPROM. 00269 * @retval EEPROM_OK (0) if operation is correctly performed, else return value 00270 * different from EEPROM_OK (0) or the timeout user callback. 00271 */ 00272 uint32_t BSP_EEPROM_WriteBuffer(uint8_t *pBuffer, uint16_t WriteAddr, uint16_t NumByteToWrite) 00273 { 00274 uint16_t numofpage = 0, numofsingle = 0, count = 0; 00275 uint16_t addr = 0; 00276 uint8_t dataindex = 0; 00277 uint32_t status = EEPROM_OK; 00278 00279 addr = WriteAddr % EEPROM_PAGESIZE; 00280 count = EEPROM_PAGESIZE - addr; 00281 numofpage = NumByteToWrite / EEPROM_PAGESIZE; 00282 numofsingle = NumByteToWrite % EEPROM_PAGESIZE; 00283 00284 /* If WriteAddr is EEPROM_PAGESIZE aligned */ 00285 if(addr == 0) 00286 { 00287 /* If NumByteToWrite < EEPROM_PAGESIZE */ 00288 if(numofpage == 0) 00289 { 00290 /* Store the number of data to be written */ 00291 dataindex = numofsingle; 00292 /* Start writing data */ 00293 status = BSP_EEPROM_WritePage(pBuffer, WriteAddr, (uint8_t*)(&dataindex)); 00294 if(status != EEPROM_OK) 00295 { 00296 return status; 00297 } 00298 } 00299 /* If NumByteToWrite > EEPROM_PAGESIZE */ 00300 else 00301 { 00302 while(numofpage--) 00303 { 00304 /* Store the number of data to be written */ 00305 dataindex = EEPROM_PAGESIZE; 00306 status = BSP_EEPROM_WritePage(pBuffer, WriteAddr, (uint8_t*)(&dataindex)); 00307 if(status != EEPROM_OK) 00308 { 00309 return status; 00310 } 00311 00312 WriteAddr += EEPROM_PAGESIZE; 00313 pBuffer += EEPROM_PAGESIZE; 00314 } 00315 00316 if(numofsingle!=0) 00317 { 00318 /* Store the number of data to be written */ 00319 dataindex = numofsingle; 00320 status = BSP_EEPROM_WritePage(pBuffer, WriteAddr, (uint8_t*)(&dataindex)); 00321 if(status != EEPROM_OK) 00322 { 00323 return status; 00324 } 00325 } 00326 } 00327 } 00328 /* If WriteAddr is not EEPROM_PAGESIZE aligned */ 00329 else 00330 { 00331 /* If NumByteToWrite < EEPROM_PAGESIZE */ 00332 if(numofpage== 0) 00333 { 00334 /* If the number of data to be written is more than the remaining space 00335 in the current page: */ 00336 if(NumByteToWrite > count) 00337 { 00338 /* Store the number of data to be written */ 00339 dataindex = count; 00340 /* Write the data contained in same page */ 00341 status = BSP_EEPROM_WritePage(pBuffer, WriteAddr, (uint8_t*)(&dataindex)); 00342 if(status != EEPROM_OK) 00343 { 00344 return status; 00345 } 00346 00347 /* Store the number of data to be written */ 00348 dataindex = (NumByteToWrite - count); 00349 /* Write the remaining data in the following page */ 00350 status = BSP_EEPROM_WritePage((uint8_t*)(pBuffer + count), (WriteAddr + count), (uint8_t*)(&dataindex)); 00351 if(status != EEPROM_OK) 00352 { 00353 return status; 00354 } 00355 } 00356 else 00357 { 00358 /* Store the number of data to be written */ 00359 dataindex = numofsingle; 00360 status = BSP_EEPROM_WritePage(pBuffer, WriteAddr, (uint8_t*)(&dataindex)); 00361 if(status != EEPROM_OK) 00362 { 00363 return status; 00364 } 00365 } 00366 } 00367 /* If NumByteToWrite > EEPROM_PAGESIZE */ 00368 else 00369 { 00370 NumByteToWrite -= count; 00371 numofpage = NumByteToWrite / EEPROM_PAGESIZE; 00372 numofsingle = NumByteToWrite % EEPROM_PAGESIZE; 00373 00374 if(count != 0) 00375 { 00376 /* Store the number of data to be written */ 00377 dataindex = count; 00378 status = BSP_EEPROM_WritePage(pBuffer, WriteAddr, (uint8_t*)(&dataindex)); 00379 if(status != EEPROM_OK) 00380 { 00381 return status; 00382 } 00383 WriteAddr += count; 00384 pBuffer += count; 00385 } 00386 00387 while(numofpage--) 00388 { 00389 /* Store the number of data to be written */ 00390 dataindex = EEPROM_PAGESIZE; 00391 status = BSP_EEPROM_WritePage(pBuffer, WriteAddr, (uint8_t*)(&dataindex)); 00392 if(status != EEPROM_OK) 00393 { 00394 return status; 00395 } 00396 WriteAddr += EEPROM_PAGESIZE; 00397 pBuffer += EEPROM_PAGESIZE; 00398 } 00399 if(numofsingle != 0) 00400 { 00401 /* Store the number of data to be written */ 00402 dataindex = numofsingle; 00403 status = BSP_EEPROM_WritePage(pBuffer, WriteAddr, (uint8_t*)(&dataindex)); 00404 if(status != EEPROM_OK) 00405 { 00406 return status; 00407 } 00408 } 00409 } 00410 } 00411 00412 /* If all operations OK, return EEPROM_OK (0) */ 00413 return EEPROM_OK; 00414 } 00415 00416 /** 00417 * @brief Wait for EEPROM Standby state. 00418 * 00419 * @note This function allows to wait and check that EEPROM has finished the 00420 * last operation. It is mostly used after Write operation: after receiving 00421 * the buffer to be written, the EEPROM may need additional time to actually 00422 * perform the write operation. During this time, it doesn't answer to 00423 * I2C packets addressed to it. Once the write operation is complete 00424 * the EEPROM responds to its address. 00425 * 00426 * @retval EEPROM_OK (0) if operation is correctly performed, else return value 00427 * different from EEPROM_OK (0) or the timeout user callback. 00428 */ 00429 uint32_t BSP_EEPROM_WaitEepromStandbyState(void) 00430 { 00431 /* Check if the maximum allowed number of trials has bee reached */ 00432 if(EEPROM_IO_IsDeviceReady(EEPROMAddress, EEPROM_MAX_TRIALS) != HAL_OK) 00433 { 00434 /* If the maximum number of trials has been reached, exit the function */ 00435 BSP_EEPROM_TIMEOUT_UserCallback(); 00436 return EEPROM_TIMEOUT; 00437 } 00438 return EEPROM_OK; 00439 } 00440 00441 /** 00442 * @brief Basic management of the timeout situation. 00443 */ 00444 __weak void BSP_EEPROM_TIMEOUT_UserCallback(void) 00445 { 00446 } 00447 00448 /** 00449 * @} 00450 */ 00451 00452 /** 00453 * @} 00454 */ 00455 00456 /** 00457 * @} 00458 */ 00459 00460 /** 00461 * @} 00462 */ 00463 00464 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
Generated on Wed Jan 13 2016 15:52:54 for STM324x9I_EVAL BSP User Manual by
1.7.6.1