Phoenard
FlashMemoryStream.h
Go to the documentation of this file.
1 /*
2 The MIT License (MIT)
3 
4 This file is part of the Phoenard Arduino library
5 Copyright (c) 2014 Phoenard
6 
7 Permission is hereby granted, free of charge, to any person obtaining a copy
8 of this software and associated documentation files (the "Software"), to deal
9 in the Software without restriction, including without limitation the rights
10 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 copies of the Software, and to permit persons to whom the Software is
12 furnished to do so, subject to the following conditions:
13 
14 The above copyright notice and this permission notice shall be included in
15 all copies or substantial portions of the Software.
16 
17 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23 THE SOFTWARE.
24 */
25 
31 #include <Arduino.h>
32 #include <avr/pgmspace.h>
33 
34 #ifndef _FLASH_MEM_STREAM_H_
35 #define _FLASH_MEM_STREAM_H_
36 
42 class FlashMemoryStream : public Stream {
43  private:
44  const uint8_t *_startAddress;
45  uint32_t _pos;
46  uint32_t _length;
47  public:
49  FlashMemoryStream(const void *startAddress, uint32_t length = 0xFFFFFFFF);
50 
51  virtual int read();
52  virtual int peek();
53  virtual int available();
54  virtual void flush();
56  void seek(uint16_t position);
58  void reset(void);
60  size_t write(uint8_t val);
61 };
62 
63 #endif
Reads flash memory as a data stream.
Definition: FlashMemoryStream.h:42
void reset(void)
Resets the stream to the beginning.
Definition: FlashMemoryStream.cpp:58
size_t write(uint8_t val)
Writing to flash memory is not supported - does nothing.
Definition: FlashMemoryStream.cpp:62
FlashMemoryStream(const void *startAddress, uint32_t length=0xFFFFFFFF)
Creates a new Flash Memory stream reading from at the address specified.
Definition: FlashMemoryStream.cpp:28
void seek(uint16_t position)
Seeks the stream to a certain position in memory.
Definition: FlashMemoryStream.cpp:54