You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
80 lines
3.1 KiB
80 lines
3.1 KiB
/**************************************************************************//**
|
|
* BASpiMemory is convenience class for accessing the optional SPI RAMs on
|
|
* the GTA Series boards.
|
|
*
|
|
* @file
|
|
* @author Steve Lascos
|
|
* @company Blackaddr Audio
|
|
* @copyright 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 <http://www.gnu.org/licenses/>.
|
|
*****************************************************************************/
|
|
#ifndef SRC_BASPIMEMORY_H_
|
|
#define SRC_BASPIMEMORY_H_
|
|
|
|
#include <SPI.h>
|
|
|
|
namespace BAGuitar {
|
|
|
|
constexpr int SPI_MAX_ADDR = 131071; ///< Max address size per chip
|
|
|
|
/**************************************************************************//**
|
|
* This class enumerates access to the two potential SPI RAMs.
|
|
*****************************************************************************/
|
|
|
|
enum class SpiDeviceId {
|
|
SPI_DEVICE0,
|
|
SPI_DEVICE1
|
|
};
|
|
|
|
/**************************************************************************//**
|
|
* This wrapper class uses the Arduino SPI (Wire) library to access the SPI ram.
|
|
* @details The purpose of this class is primilary for functional testing since
|
|
* it currently support single-word access. High performance access should be
|
|
* done using DMA techniques in the Teensy library.
|
|
*****************************************************************************/
|
|
class BASpiMemory {
|
|
public:
|
|
BASpiMemory() = delete;
|
|
/// Create an object to control either MEM0 (via SPI1) or MEM1 (via SPI2).
|
|
/// @details default is 20 Mhz
|
|
/// @param memDeviceId specify which MEM to controlw with SpiDeviceId.
|
|
BASpiMemory(SpiDeviceId memDeviceId);
|
|
/// Create an object to control either MEM0 (via SPI1) or MEM1 (via SPI2)
|
|
/// @param memDeviceId specify which MEM to controlw with SpiDeviceId.
|
|
/// @param speedHz specify the desired speed in Hz.
|
|
BASpiMemory(SpiDeviceId memDeviceId, uint32_t speedHz);
|
|
virtual ~BASpiMemory();
|
|
|
|
/// write a single data word to the specified address
|
|
/// @param address the address in the SPI RAM to write to
|
|
/// @param data the value to write
|
|
void write(int address, int data);
|
|
|
|
/// read a single data word from the specified address
|
|
/// @param address the address in the SPI RAM to read from
|
|
/// @return the data that was read
|
|
int read(int address);
|
|
|
|
private:
|
|
SpiDeviceId m_memDeviceId; // the MEM device being control with this instance
|
|
uint8_t m_csPin; // the IO pin number for the CS on the controlled SPI device
|
|
SPISettings m_settings; // the Wire settings for this SPI port
|
|
void m_Init();
|
|
|
|
};
|
|
|
|
class BASpiMemoryException {};
|
|
|
|
} /* namespace BAGuitar */
|
|
|
|
#endif /* SRC_BASPIMEMORY_H_ */
|
|
|