-- Copyright (C)2026, Philip Munts dba Munts Technologies.
--
-- Redistribution and use in source and binary forms, with or without
-- modification, are permitted provided that the following conditions are met:
--
-- * Redistributions of source code must retain the above copyright notice,
--   this list of conditions and the following disclaimer.
--
-- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-- AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-- IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-- ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
-- LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-- CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
-- SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-- INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
-- CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
-- ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
-- POSSIBILITY OF SUCH DAMAGE.

-- See https://cdn.sparkfun.com/assets/e/2/7/6/b/ProMicroRP2040_Graphical_Datasheet.pdf

WITH RP.GPIO;

PACKAGE SparkFun_ProMicro_RP2040 IS

  Crystal : CONSTANT := 12_000_000; -- Hz

  -- Left edge (DIP pin order)

  GP0  : RP.GPIO.GPIO_Pin := 0;
  GP1  : RP.GPIO.GPIO_Pin := 1;
  GP2  : RP.GPIO.GPIO_Pin := 2;
  GP3  : RP.GPIO.GPIO_Pin := 3;
  GP4  : RP.GPIO.GPIO_Pin := 4;
  GP5  : RP.GPIO.GPIO_Pin := 5;
  GP6  : RP.GPIO.GPIO_Pin := 6;
  GP7  : RP.GPIO.GPIO_Pin := 7;
  GP8  : RP.GPIO.GPIO_Pin := 8;
  GP9  : RP.GPIO.GPIO_Pin := 9;

  TXD0 RENAMES GP0;
  RXD0 RENAMES GP1;

  TXD1 RENAMES GP8;
  RXD1 RENAMES GP9;

  -- QWIIC connector

  GP16 : RP.GPIO.GPIO_Pin := 16;  -- aka SDA
  GP17 : RP.GPIO.GPIO_Pin := 17;  -- aka SCL

  SDA0 RENAMES GP16;
  SCL0 RENAMES GP17;

  -- Right edge (DIP pin order)

  GP21 : RP.GPIO.GPIO_Pin := 21;  -- aka SS
  GP23 : RP.GPIO.GPIO_Pin := 23;  -- aka MOSI
  GP20 : RP.GPIO.GPIO_Pin := 20;  -- aka MISO
  GP22 : RP.GPIO.GPIO_Pin := 22;  -- aka SCK
  GP26 : RP.GPIO.GPIO_Pin := 26;  -- aka ADC0
  GP27 : RP.GPIO.GPIO_Pin := 27;  -- aka ADC1
  GP28 : RP.GPIO.GPIO_Pin := 28;  -- aka ADC2
  GP29 : RP.GPIO.GPIO_Pin := 29;  -- aka ADC3

  ADC0 RENAMES GP26;
  ADC1 RENAMES GP27;
  ADC2 RENAMES GP28;
  ADC3 RENAMES GP29;

  MISO RENAMES GP20;
  MOSI RENAMES GP23;
  SCK  RENAMES GP22;
  SS   RENAMES GP21;

END SparkFun_ProMicro_RP2040;