softspi.h File Reference

#include "../HAL/shared/Marduino.h"
#include <avr/io.h>
#include <util/atomic.h>

Go to the source code of this file.

Classes
class	pin_map_t
	struct for mapping digital pins More...
class	DigitalPin< PinNumber >
	Fast digital port I/O. More...
class	SoftSPI< MisoPin, MosiPin, SckPin, Mode >
	Fast software SPI. More...

Macros
#define	FORCE_INLINE   inline __attribute__((always_inline))
#define	nop   __asm__ volatile ("nop")

Functions
void	badPinNumber () __attribute__((error("Pin number is too large or not a const ant")))
static FORCE_INLINE void	badPinCheck (const uint8_t pin)
static FORCE_INLINE void	fastBitWriteSafe (volatile uint8_t *address, uint8_t bit, bool level)
static FORCE_INLINE bool	fastDigitalRead (uint8_t pin)
static FORCE_INLINE void	fastDigitalToggle (uint8_t pin)
static FORCE_INLINE void	fastDigitalWrite (uint8_t pin, bool level)
static FORCE_INLINE void	fastPinMode (uint8_t pin, bool mode)
static FORCE_INLINE void	fastPinConfig (uint8_t pin, bool mode, bool level)

Variables
static constexpr uint8_t	digitalPinCount = sizeof(pinMap) / sizeof(pin_map_t)
const bool	MISO_MODE = false
const bool	MISO_LEVEL = false
const bool	MOSI_MODE = true
const bool	SCK_MODE = true

Macro Definition Documentation

FORCE_INLINE

#define FORCE_INLINE   inline __attribute__((always_inline))

Marlin 3D Printer Firmware Copyright (c) 2019 MarlinFirmware [https://github.com/MarlinFirmware/Marlin]

Based on Sprinter and grbl. Copyright (c) 2011 Camiel Gubbels / Erik van der Zalm

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/.

nop

#define nop   __asm__ volatile ("nop")

Function Documentation

badPinNumber()

void badPinNumber

(

)

const

generate bad pin number error

Here is the caller graph for this function:

badPinCheck()

static FORCE_INLINE void badPinCheck ( const uint8_t  pin )

static

Check for valid pin number

Parameters

[in]

pin

Number of pin to be checked.

                                                          {
    if (!__builtin_constant_p(pin) || pin >= digitalPinCount) badPinNumber();
  }

Here is the call graph for this function:

Here is the caller graph for this function:

fastBitWriteSafe()

static FORCE_INLINE void fastBitWriteSafe ( volatile uint8_t *  address, uint8_t  bit, bool  level  )

static

Fast write helper

Parameters

[in]	address	I/O register address
[in]	bit	bit number to write
[in]	level	value for bit

                                                                                                {
    uint8_t oldSREG;
    if (address > (uint8_t*)0x5F) { oldSREG = SREG; cli(); }
    if (level) SBI(*address, bit); else CBI(*address, bit);
    if (address > (uint8_t*)0x5F) SREG = oldSREG;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

fastDigitalRead()

static FORCE_INLINE bool fastDigitalRead ( uint8_t  pin )

static

Read pin value

Parameters

[in]

pin

Arduino pin number

Returns

value read

                                                        {
    badPinCheck(pin);
    return (*pinMap[pin].pin >> pinMap[pin].bit) & 1;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

fastDigitalToggle()

static FORCE_INLINE void fastDigitalToggle ( uint8_t  pin )

static

Toggle a pin

Parameters

[in]

pin

Arduino pin number

If the pin is in output mode toggle the pin level. If the pin is in input mode toggle the state of the 20K pullup.

                                                          {
    badPinCheck(pin);
    if (pinMap[pin].pin > (uint8_t*)0x5F)
      *pinMap[pin].pin = _BV(pinMap[pin].bit);  // Must write bit to high address port
    else
      SBI(*pinMap[pin].pin, pinMap[pin].bit);   // Compiles to sbi and PIN register will not be read
  }

Here is the call graph for this function:

Here is the caller graph for this function:

fastDigitalWrite()

static FORCE_INLINE void fastDigitalWrite ( uint8_t  pin, bool  level  )

static

Set pin value

Parameters

[in]	pin	Arduino pin number
[in]	level	value to write

                                                                     {
    badPinCheck(pin);
    fastBitWriteSafe(pinMap[pin].port, pinMap[pin].bit, level);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

fastPinMode()

static FORCE_INLINE void fastPinMode ( uint8_t  pin, bool  mode  )

static

Set pin mode

Parameters

[in]	pin	Arduino pin number
[in]	mode	if true set output mode else input mode

fastPinMode does not enable or disable the 20K pullup for input mode.

                                                               {
    badPinCheck(pin);
    fastBitWriteSafe(pinMap[pin].ddr, pinMap[pin].bit, mode);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

fastPinConfig()

static FORCE_INLINE void fastPinConfig ( uint8_t  pin, bool  mode, bool  level  )

static

Set pin configuration

Parameters

[in]	pin	Arduino pin number
[in]	mode	If true set output mode else input mode
[in]	level	If mode is output, set level high/low. If mode is input, enable or disable the pin's 20K pullup.

                                                                           {
  fastPinMode(pin, mode);
  fastDigitalWrite(pin, level);
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

digitalPinCount

constexpr uint8_t digitalPinCount = sizeof(pinMap) / sizeof(pin_map_t)

staticconstexpr

count of pins

MISO_MODE

const bool MISO_MODE = false

MISO_LEVEL

const bool MISO_LEVEL = false

MOSI_MODE

const bool MOSI_MODE = true

SCK_MODE

const bool SCK_MODE = true