Arduino.h

Go to the documentation of this file.

#pragma once
 
#include "api/ArduinoAPI.h"
#include "api/itoa.h"                          // itoa(), utoa(), ltoa(), ultoa()
#include "api/deprecated-avr-comp/avr/dtostrf.h"  // dtostrf(), common in AVR-era sketches
#include "pico.h"
 
#include "pins_arduino.h"
 
// --- Interrupt enable/disable (ArduinoCore-API leaves these to the core) -----
#define interrupts()    __asm volatile("cpsie i" ::: "memory")
#define noInterrupts()  __asm volatile("cpsid i" ::: "memory")
 
#ifdef __cplusplus
 
using namespace arduino;
 
// --- Pin mapping ---------------------------------------------------------------
#if __cplusplus >= 201703L
inline constexpr uint8_t kPinToGpio[] = PHYDUINO_PIN_TO_GPIO;
#else
static constexpr uint8_t kPinToGpio[] = PHYDUINO_PIN_TO_GPIO;  // C++14: no inline variables
#endif
static_assert(sizeof(kPinToGpio) == PINS_COUNT,
              "pins_arduino.h: PHYDUINO_PIN_TO_GPIO needs exactly PINS_COUNT entries");

inline uint8_t digitalPinToGpio(pin_size_t pin) {
    return pin < PINS_COUNT ? kPinToGpio[pin] : NOT_A_GPIO;
}

#define digitalPinToInterrupt(pin)  (pin)
 
// --- Phyduino extensions to the Arduino API ------------------------------------
void analogReadResolution(int bits);

void analogWriteResolution(int bits);

void analogWriteFrequency(uint32_t hz);
 
// --- Phyduino analog acquisition: every analog pin (wiring_analog.cpp, analog_burst.cpp)
void analogReadAveraging(uint8_t samples);

uint32_t analogFullScaleMillivolts(pin_size_t pin);

uint32_t analogReadMillivolts(pin_size_t pin);

int32_t analogReadDifferentialMillivolts(pin_size_t plus, pin_size_t minus);

bool analogReadMultiple(const pin_size_t* pins, uint8_t count, uint16_t* results);

uint32_t analogReadBurst(pin_size_t pin, uint16_t* buffer, size_t count, uint32_t sample_rate_hz);

uint32_t analogStartBurst(pin_size_t pin, uint16_t* buffer, size_t count, uint32_t sample_rate_hz);

bool analogBurstDone();

void analogStopBurst();
 
// --- Variant hooks: every variants/<board>/variant.cpp must define these ------
// (initVariant() is declared by ArduinoCore-API.) They handle analog pins with
// no RP2040 GPIO (e.g. an external ADC); sketches use the analog functions above.

uint16_t variantAnalogRead(pin_size_t pin);

uint32_t variantAnalogFullScaleMillivolts(pin_size_t pin);

void variantAnalogReadAveraging(uint8_t samples);

bool variantAnalogReadMultiple(const pin_size_t* pins, uint8_t count, uint16_t* raw);

bool variantAnalogReadDifferential(pin_size_t plus, pin_size_t minus, int32_t* millivolts);

uint32_t variantAnalogStartBurst(pin_size_t pin, uint16_t* buffer, size_t count, uint32_t sample_rate_hz);

bool variantAnalogBurstDone();

void variantAnalogStopBurst();

 
// --- Serial ports ----------------------------------------------------------------
#include "SerialUSB.h"
#include "SerialUART.h"
 
// --- Multicore: setup1()/loop1(), rp2040.fifo -----------------------------------
#include "RP2040.h"
 
#endif  // __cplusplus