From 20df47f7357a802d51667312245e5a3960dec573 Mon Sep 17 00:00:00 2001 From: Doxygen CI Date: Wed, 28 Aug 2024 08:08:06 +0000 Subject: [PATCH] Deploy docs to GitHub Pages from commit 0d912ef237 Commit: 0d912ef2378df9ffbf2e5156406fdf3d2ed9b49e GitHub Actions run: 10592668820 --- html/_adafruit___f_r_a_m___s_p_i_8cpp.html | 2 +- ..._adafruit___f_r_a_m___s_p_i_8h_source.html | 26 +++++++++---------- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/html/_adafruit___f_r_a_m___s_p_i_8cpp.html b/html/_adafruit___f_r_a_m___s_p_i_8cpp.html index cf9c6d4..9f92566 100644 --- a/html/_adafruit___f_r_a_m___s_p_i_8cpp.html +++ b/html/_adafruit___f_r_a_m___s_p_i_8cpp.html @@ -110,7 +110,7 @@

-Initial value:
= {
{0x04, 0x0101, 2 * 1024UL, false},
{0x04, 0x0302, 8 * 1024UL, false},
{0x04, 0x2303, 8 * 1024UL, true},
{0x04, 0x2503, 32 * 1024UL, true},
{0x04, 0x2703, 128 * 1024UL, true},
{0x04, 0x4803, 256 * 1024UL, true},
{0x04, 0x2803, 256 * 1024UL, true},
{0x04, 0x4903, 512 * 1024UL, true},
{0x7F, 0x7F7f, 32 * 1024UL, false},
{0xAE, 0x8305, 8 * 1024UL, false}
}
+Initial value:
= {
{0x04, 0x0101, 2 * 1024UL, false},
{0x04, 0x0302, 8 * 1024UL, false},
{0x04, 0x2303, 8 * 1024UL, true},
{0x04, 0x2503, 32 * 1024UL, true},
{0x04, 0x2703, 128 * 1024UL, true},
{0x04, 0x4803, 256 * 1024UL, true},
{0x04, 0x2803, 256 * 1024UL, true},
{0x04, 0x4903, 512 * 1024UL, true},
{0x04, 0x490B, 512 * 1024UL, true},
{0x7F, 0x7F7f, 32 * 1024UL, false},
{0xAE, 0x8305, 8 * 1024UL, false}
}

Supported flash devices.

diff --git a/html/_adafruit___f_r_a_m___s_p_i_8h_source.html b/html/_adafruit___f_r_a_m___s_p_i_8h_source.html index a476f29..5ed1996 100644 --- a/html/_adafruit___f_r_a_m___s_p_i_8h_source.html +++ b/html/_adafruit___f_r_a_m___s_p_i_8h_source.html @@ -62,22 +62,22 @@
Adafruit_FRAM_SPI.h
-Go to the documentation of this file.
1 
22 #ifndef _ADAFRUIT_FRAM_SPI_H_
23 #define _ADAFRUIT_FRAM_SPI_H_
24 
25 #include <Adafruit_SPIDevice.h>
26 #include <Arduino.h>
27 #include <SPI.h>
28 
30 typedef enum opcodes_e {
31  OPCODE_WREN = 0b0110, /* Write Enable Latch */
32  OPCODE_WRDI = 0b0100, /* Reset Write Enable Latch */
33  OPCODE_RDSR = 0b0101, /* Read Status Register */
34  OPCODE_WRSR = 0b0001, /* Write Status Register */
35  OPCODE_READ = 0b0011, /* Read Memory */
36  OPCODE_WRITE = 0b0010, /* Write Memory */
37  OPCODE_RDID = 0b10011111, /* Read Device ID */
38  OPCODE_SLEEP = 0b10111001 /* Sleep Mode */
39 } opcodes_t;
40 
45 class Adafruit_FRAM_SPI {
46 public:
47  Adafruit_FRAM_SPI(int8_t cs, SPIClass *theSPI = &SPI,
48  uint32_t freq = 1000000);
49  Adafruit_FRAM_SPI(int8_t clk, int8_t miso, int8_t mosi, int8_t cs);
50  virtual ~Adafruit_FRAM_SPI(void);
51 
52  bool begin(uint8_t nAddressSizeBytes = 2);
53  bool writeEnable(bool enable);
54  bool write8(uint32_t addr, uint8_t value);
55  bool write(uint32_t addr, const uint8_t *values, size_t count);
56  uint8_t read8(uint32_t addr);
57  bool read(uint32_t addr, uint8_t *values, size_t count);
58  bool getDeviceID(uint8_t *manufacturerID, uint16_t *productID);
59  uint8_t getStatusRegister(void);
60  bool setStatusRegister(uint8_t value);
61  void setAddressSize(uint8_t nAddressSize);
62  bool enterSleep(void);
63  bool exitSleep(void);
64 
65 private:
66  void init(void);
67  Adafruit_SPIDevice *spi_dev;
68  uint8_t _nAddressSizeBytes;
69  int _dev_idx;
70 };
71 
72 #endif
Adafruit_FRAM_SPI::write8
bool write8(uint32_t addr, uint8_t value)
Writes a byte at the specific FRAM address.
Definition: Adafruit_FRAM_SPI.cpp:211
-
Adafruit_FRAM_SPI::write
bool write(uint32_t addr, const uint8_t *values, size_t count)
Writes count bytes starting at the specific FRAM address.
Definition: Adafruit_FRAM_SPI.cpp:239
-
Adafruit_FRAM_SPI::writeEnable
bool writeEnable(bool enable)
Enables or disables writing to the SPI flash.
Definition: Adafruit_FRAM_SPI.cpp:192
-
Adafruit_FRAM_SPI::getDeviceID
bool getDeviceID(uint8_t *manufacturerID, uint16_t *productID)
Reads the Manufacturer ID and the Product ID from the IC.
Definition: Adafruit_FRAM_SPI.cpp:319
-
Adafruit_FRAM_SPI::exitSleep
bool exitSleep(void)
exits the FRAM&#39;s low power sleep mode
Definition: Adafruit_FRAM_SPI.cpp:399
-
Adafruit_FRAM_SPI::read8
uint8_t read8(uint32_t addr)
Reads an 8 bit value from the specified FRAM address.
Definition: Adafruit_FRAM_SPI.cpp:263
-
Adafruit_FRAM_SPI::setStatusRegister
bool setStatusRegister(uint8_t value)
Sets the status register.
Definition: Adafruit_FRAM_SPI.cpp:363
-
Adafruit_FRAM_SPI::begin
bool begin(uint8_t nAddressSizeBytes=2)
Initializes SPI and configures the chip (call this function before doing anything else) ...
Definition: Adafruit_FRAM_SPI.cpp:140
-
Adafruit_FRAM_SPI::setAddressSize
void setAddressSize(uint8_t nAddressSize)
Sets adress size to provided value.
Definition: Adafruit_FRAM_SPI.cpp:377
-
Adafruit_FRAM_SPI::enterSleep
bool enterSleep(void)
Enters the FRAM&#39;s low power sleep mode.
Definition: Adafruit_FRAM_SPI.cpp:386
-
Adafruit_FRAM_SPI::Adafruit_FRAM_SPI
Adafruit_FRAM_SPI(int8_t cs, SPIClass *theSPI=&SPI, uint32_t freq=1000000)
Instantiates a new SPI FRAM class using hardware SPI.
Definition: Adafruit_FRAM_SPI.cpp:102
+Go to the documentation of this file.
1 
22 #ifndef _ADAFRUIT_FRAM_SPI_H_
23 #define _ADAFRUIT_FRAM_SPI_H_
24 
25 #include <Adafruit_SPIDevice.h>
26 #include <Arduino.h>
27 #include <SPI.h>
28 
30 typedef enum opcodes_e {
31  OPCODE_WREN = 0b0110, /* Write Enable Latch */
32  OPCODE_WRDI = 0b0100, /* Reset Write Enable Latch */
33  OPCODE_RDSR = 0b0101, /* Read Status Register */
34  OPCODE_WRSR = 0b0001, /* Write Status Register */
35  OPCODE_READ = 0b0011, /* Read Memory */
36  OPCODE_WRITE = 0b0010, /* Write Memory */
37  OPCODE_RDID = 0b10011111, /* Read Device ID */
38  OPCODE_SLEEP = 0b10111001 /* Sleep Mode */
39 } opcodes_t;
40 
45 class Adafruit_FRAM_SPI {
46 public:
47  Adafruit_FRAM_SPI(int8_t cs, SPIClass *theSPI = &SPI,
48  uint32_t freq = 1000000);
49  Adafruit_FRAM_SPI(int8_t clk, int8_t miso, int8_t mosi, int8_t cs);
50  virtual ~Adafruit_FRAM_SPI(void);
51 
52  bool begin(uint8_t nAddressSizeBytes = 2);
53  bool writeEnable(bool enable);
54  bool write8(uint32_t addr, uint8_t value);
55  bool write(uint32_t addr, const uint8_t *values, size_t count);
56  uint8_t read8(uint32_t addr);
57  bool read(uint32_t addr, uint8_t *values, size_t count);
58  bool getDeviceID(uint8_t *manufacturerID, uint16_t *productID);
59  uint8_t getStatusRegister(void);
60  bool setStatusRegister(uint8_t value);
61  void setAddressSize(uint8_t nAddressSize);
62  bool enterSleep(void);
63  bool exitSleep(void);
64 
65 private:
66  void init(void);
67  Adafruit_SPIDevice *spi_dev;
68  uint8_t _nAddressSizeBytes;
69  int _dev_idx;
70 };
71 
72 #endif
Adafruit_FRAM_SPI::write8
bool write8(uint32_t addr, uint8_t value)
Writes a byte at the specific FRAM address.
Definition: Adafruit_FRAM_SPI.cpp:212
+
Adafruit_FRAM_SPI::write
bool write(uint32_t addr, const uint8_t *values, size_t count)
Writes count bytes starting at the specific FRAM address.
Definition: Adafruit_FRAM_SPI.cpp:240
+
Adafruit_FRAM_SPI::writeEnable
bool writeEnable(bool enable)
Enables or disables writing to the SPI flash.
Definition: Adafruit_FRAM_SPI.cpp:193
+
Adafruit_FRAM_SPI::getDeviceID
bool getDeviceID(uint8_t *manufacturerID, uint16_t *productID)
Reads the Manufacturer ID and the Product ID from the IC.
Definition: Adafruit_FRAM_SPI.cpp:320
+
Adafruit_FRAM_SPI::exitSleep
bool exitSleep(void)
exits the FRAM&#39;s low power sleep mode
Definition: Adafruit_FRAM_SPI.cpp:400
+
Adafruit_FRAM_SPI::read8
uint8_t read8(uint32_t addr)
Reads an 8 bit value from the specified FRAM address.
Definition: Adafruit_FRAM_SPI.cpp:264
+
Adafruit_FRAM_SPI::setStatusRegister
bool setStatusRegister(uint8_t value)
Sets the status register.
Definition: Adafruit_FRAM_SPI.cpp:364
+
Adafruit_FRAM_SPI::begin
bool begin(uint8_t nAddressSizeBytes=2)
Initializes SPI and configures the chip (call this function before doing anything else) ...
Definition: Adafruit_FRAM_SPI.cpp:141
+
Adafruit_FRAM_SPI::setAddressSize
void setAddressSize(uint8_t nAddressSize)
Sets adress size to provided value.
Definition: Adafruit_FRAM_SPI.cpp:378
+
Adafruit_FRAM_SPI::enterSleep
bool enterSleep(void)
Enters the FRAM&#39;s low power sleep mode.
Definition: Adafruit_FRAM_SPI.cpp:387
+
Adafruit_FRAM_SPI::Adafruit_FRAM_SPI
Adafruit_FRAM_SPI(int8_t cs, SPIClass *theSPI=&SPI, uint32_t freq=1000000)
Instantiates a new SPI FRAM class using hardware SPI.
Definition: Adafruit_FRAM_SPI.cpp:103
Adafruit_FRAM_SPI
Class that stores state and functions for interacting with FRAM SPI.
Definition: Adafruit_FRAM_SPI.h:45
-
Adafruit_FRAM_SPI::getStatusRegister
uint8_t getStatusRegister(void)
Reads the status register.
Definition: Adafruit_FRAM_SPI.cpp:347
+
Adafruit_FRAM_SPI::getStatusRegister
uint8_t getStatusRegister(void)
Reads the status register.
Definition: Adafruit_FRAM_SPI.cpp:348
opcodes_t
enum opcodes_e opcodes_t
opcodes_e
opcodes_e
Definition: Adafruit_FRAM_SPI.h:30
-
Adafruit_FRAM_SPI::read
bool read(uint32_t addr, uint8_t *values, size_t count)
Read count bytes starting at the specific FRAM address.
Definition: Adafruit_FRAM_SPI.cpp:292
+
Adafruit_FRAM_SPI::read
bool read(uint32_t addr, uint8_t *values, size_t count)
Read count bytes starting at the specific FRAM address.
Definition: Adafruit_FRAM_SPI.cpp:293