SPIDefs.h

Go to the documentation of this file.

/* Copyright (c) 2021 Skyward Experimental Rocketry
 * Author: Alberto Nidasio
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
 
#pragma once
 
#include <interfaces/arch_registers.h>
#include <stdint.h>
 
namespace Boardcore
{
 
namespace SPI
{
 
enum class Order : uint16_t
{
    MSB_FIRST = 0,
    LSB_FIRST = SPI_CR1_LSBFIRST
};
 
enum class ClockDivider : uint8_t
{
    DIV_2   = 0x00,
    DIV_4   = SPI_CR1_BR_0,
    DIV_8   = SPI_CR1_BR_1,
    DIV_16  = SPI_CR1_BR_1 | SPI_CR1_BR_0,
    DIV_32  = SPI_CR1_BR_2,
    DIV_64  = SPI_CR1_BR_2 | SPI_CR1_BR_0,
    DIV_128 = SPI_CR1_BR_2 | SPI_CR1_BR_1,
    DIV_256 = SPI_CR1_BR
};
 
enum class Mode : uint8_t
{
    MODE_0 = 0,
    MODE_1 = SPI_CR1_CPHA,
    MODE_2 = SPI_CR1_CPOL,
    MODE_3 = SPI_CR1_CPOL | SPI_CR1_CPHA
};
 
enum class WriteBit
{
    NORMAL,    
    INVERTED,  
    DISABLED,  
};
 
}  // namespace SPI
 
}  // namespace Boardcore