aboutsummaryrefslogtreecommitdiffstats
path: root/include/flash.h
blob: 47daf8e1215cacb7d9c0aafe820461458554a293 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
/**
 * @file flash.h
 * Provides functionality for using an external SPI flash 
 *
 * Copyright (C) 2018 Clyne Sullivan
 *
 * 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 3 of the License, or
 * (at your option) 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.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

#ifndef FLASH_H_
#define FLASH_H_

#include <stdint.h>

/**
 * Initializes GPIO ports and variables for flash IO. Must be called before
 * any reads or writes.
 */
void flash_init(void);

/**
 * Does a blocking read of the flash chip into a pre-allocated buffer.
 * @param buf the buffer to read in to
 * @param addr the address to read from in the flash chip
 * @param count the number of bytes to read from the chip
 */
void flash_read(char *buf, uint32_t addr, unsigned int count);

/**
 * Does a blocking write to the flash chip using data from a pre-allocated
 * buffer.
 * @param buf the buffer to read data from
 * @param addr the address to write to in the flash chip
 * @param count the number of bytes to write to the chip
 */
void flash_write(const char *buf, uint32_t addr, unsigned int count);

#endif // FLASH_H_