ExtFlash.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015-2016, Texas Instruments Incorporated
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *
12  * * Redistributions in binary form must reproduce the above copyright
13  * notice, this list of conditions and the following disclaimer in the
14  * documentation and/or other materials provided with the distribution.
15  *
16  * * Neither the name of Texas Instruments Incorporated nor the names of
17  * its contributors may be used to endorse or promote products derived
18  * from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
24  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
27  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
29  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
30  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 
40 #ifndef EXT_FLASH_H
41 #define EXT_FLASH_H
42 
43 #include <stdlib.h>
44 #include <stdbool.h>
45 
46 #define EXT_FLASH_PAGE_SIZE 4096
47 
48 #ifdef __cplusplus
49 extern "C"
50 {
51 #endif
52 
53 typedef struct
54 {
55  uint32_t deviceSize; // bytes
56  uint8_t manfId; // manufacturer ID
57  uint8_t devId; // device ID
58 } ExtFlashInfo_t;
59 
65 extern bool ExtFlash_open(void);
66 
70 extern void ExtFlash_close(void);
71 
75 extern ExtFlashInfo_t *ExtFlash_info(void);
76 
82 extern bool ExtFlash_read(size_t offset, size_t length, uint8_t *buf);
83 
89 extern bool ExtFlash_erase(size_t offset, size_t length);
90 
96 extern bool ExtFlash_write(size_t offset, size_t length, const uint8_t *buf);
97 
103 extern bool ExtFlash_test(void);
104 
105 #ifdef __cplusplus
106 }
107 #endif
108 
109 #endif /* EXT_FLASH_H */
ExtFlashInfo_t::deviceSize
uint32_t deviceSize
Definition: ExtFlash.h:55
ExtFlash_write
bool ExtFlash_write(size_t offset, size_t length, const uint8_t *buf)
ExtFlash_erase
bool ExtFlash_erase(size_t offset, size_t length)
ExtFlash_test
bool ExtFlash_test(void)
ExtFlash_close
void ExtFlash_close(void)
ExtFlash_read
bool ExtFlash_read(size_t offset, size_t length, uint8_t *buf)
ExtFlash_info
ExtFlashInfo_t * ExtFlash_info(void)
ExtFlashInfo_t
Definition: ExtFlash.h:53
ExtFlashInfo_t::devId
uint8_t devId
Definition: ExtFlash.h:57
ExtFlashInfo_t::manfId
uint8_t manfId
Definition: ExtFlash.h:56
ExtFlash_open
bool ExtFlash_open(void)
Copyright 2017, Texas Instruments Incorporated