{ Raspberry Pi 5 Peripheral Subsystem Designator Definitions }

{ Copyright (C)2024, 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.                                                 }

namespace IO.Objects.SimpleIO.Platforms.RaspberryPi5;

const

  { Raspberry Pi boards don't have a built-in ADC (Analog to Digital    }
  { Converter) subsystem, so the following analog input designators are }
  { placeholders for the first IIO (Industrial I/O) ADC device.         }

  AIN0   : IO.Objects.SimpleIO.Resources.Designator = (chip : 0; channel :  0);
  AIN1   : IO.Objects.SimpleIO.Resources.Designator = (chip : 0; channel :  1);
  AIN2   : IO.Objects.SimpleIO.Resources.Designator = (chip : 0; channel :  2);
  AIN3   : IO.Objects.SimpleIO.Resources.Designator = (chip : 0; channel :  3);
  AIN4   : IO.Objects.SimpleIO.Resources.Designator = (chip : 0; channel :  4);
  AIN5   : IO.Objects.SimpleIO.Resources.Designator = (chip : 0; channel :  5);
  AIN6   : IO.Objects.SimpleIO.Resources.Designator = (chip : 0; channel :  6);
  AIN7   : IO.Objects.SimpleIO.Resources.Designator = (chip : 0; channel :  7);

  GPIO0  : IO.Objects.SimpleIO.Resources.Designator = (chip : 0; channel :  0);  { I2C0 SDA }
  GPIO1  : IO.Objects.SimpleIO.Resources.Designator = (chip : 0; channel :  1);  { I2C0 SCL }
  GPIO2  : IO.Objects.SimpleIO.Resources.Designator = (chip : 0; channel :  2);  { I2C1 SDA }
  GPIO3  : IO.Objects.SimpleIO.Resources.Designator = (chip : 0; channel :  3);  { I2C1 SCL }
  GPIO4  : IO.Objects.SimpleIO.Resources.Designator = (chip : 0; channel :  4);
  GPIO5  : IO.Objects.SimpleIO.Resources.Designator = (chip : 0; channel :  5);
  GPIO6  : IO.Objects.SimpleIO.Resources.Designator = (chip : 0; channel :  6);
  GPIO7  : IO.Objects.SimpleIO.Resources.Designator = (chip : 0; channel :  7);  { SPI0 SS1 }
  GPIO8  : IO.Objects.SimpleIO.Resources.Designator = (chip : 0; channel :  8);  { SPI0 SS0 }
  GPIO9  : IO.Objects.SimpleIO.Resources.Designator = (chip : 0; channel :  9);  { SPI0 MISO }
  GPIO10 : IO.Objects.SimpleIO.Resources.Designator = (chip : 0; channel : 10);  { SPI0 MOSI }
  GPIO11 : IO.Objects.SimpleIO.Resources.Designator = (chip : 0; channel : 11);  { SPI0 SCLK }
  GPIO12 : IO.Objects.SimpleIO.Resources.Designator = (chip : 0; channel : 12);  { PWM0 }
  GPIO13 : IO.Objects.SimpleIO.Resources.Designator = (chip : 0; channel : 13);  { PWM1 }
  GPIO14 : IO.Objects.SimpleIO.Resources.Designator = (chip : 0; channel : 14);  { PWM2, UART0 TXD }
  GPIO15 : IO.Objects.SimpleIO.Resources.Designator = (chip : 0; channel : 15);  { PWM3, UART0 RXD }
  GPIO16 : IO.Objects.SimpleIO.Resources.Designator = (chip : 0; channel : 16);  { SPI1 SS2 }
  GPIO17 : IO.Objects.SimpleIO.Resources.Designator = (chip : 0; channel : 17);  { SPI1 SS1 }
  GPIO18 : IO.Objects.SimpleIO.Resources.Designator = (chip : 0; channel : 18);  { PWM2, SPI1 SS0  }
  GPIO19 : IO.Objects.SimpleIO.Resources.Designator = (chip : 0; channel : 19);  { PWM3, SPI1 MISO }
  GPIO20 : IO.Objects.SimpleIO.Resources.Designator = (chip : 0; channel : 20);  { SPI1 MOSI }
  GPIO21 : IO.Objects.SimpleIO.Resources.Designator = (chip : 0; channel : 21);  { SPI1 SCLK }
  GPIO22 : IO.Objects.SimpleIO.Resources.Designator = (chip : 0; channel : 22);
  GPIO23 : IO.Objects.SimpleIO.Resources.Designator = (chip : 0; channel : 23);
  GPIO24 : IO.Objects.SimpleIO.Resources.Designator = (chip : 0; channel : 24);
  GPIO25 : IO.Objects.SimpleIO.Resources.Designator = (chip : 0; channel : 25);
  GPIO26 : IO.Objects.SimpleIO.Resources.Designator = (chip : 0; channel : 26);
  GPIO27 : IO.Objects.SimpleIO.Resources.Designator = (chip : 0; channel : 27);

  { All of the following subsystems require device tree overlays }

  { The Raspberry Pi 5 has additional I2C bus controllers, which can be }
  { enabled by device tree overlays i2c0-pi5, i2c1-pi5, i2c2-pi5, and   }
  { i2c3-pi5.                                                           }

  I2C0   : IO.Objects.SimpleIO.Resources.Designator = (chip : 0; channel :  0);  { GPIO0/GPIO1 or GPIO8/GPIO9 }
  I2C1   : IO.Objects.SimpleIO.Resources.Designator = (chip : 0; channel :  1);  { GPIO2/GPIO3 or GPIO10/GPIO11 }
  I2C2   : IO.Objects.SimpleIO.Resources.Designator = (chip : 0; channel :  2);  { GPIO4/GPIO5 or GPIO12/GPIO13 }
  I2C3   : IO.Objects.SimpleIO.Resources.Designator = (chip : 0; channel :  3);  { GPIO6/GPIO7 or GPIO14/GPIO15 or GPIO22/23 }

  { The Raspberry Pi 5 has two more hardware PWM controllers, two more  }
  { PWM outputs, different chip enumeration, and different pin mapping. }

  PWM0   : IO.Objects.SimpleIO.Resources.Designator = (chip : 2; channel :  0);  { GPIO12 }
  PWM1   : IO.Objects.SimpleIO.Resources.Designator = (chip : 2; channel :  1);  { GPIO13 }
  PWM2   : IO.Objects.SimpleIO.Resources.Designator = (chip : 2; channel :  2);  { GPIO14 or GPIO18 }
  PWM3   : IO.Objects.SimpleIO.Resources.Designator = (chip : 2; channel :  3);  { GPIO15 or GPIO19 }

  SPI0_0 : IO.Objects.SimpleIO.Resources.Designator = (chip : 0; channel :  0);  { GPIO8,  GPIO9,  GPIO10; and GPIO11 }
  SPI0_1 : IO.Objects.SimpleIO.Resources.Designator = (chip : 0; channel :  1);  { GPIO7,  GPIO9,  GPIO10; and GPIO11 }
  SPI1_0 : IO.Objects.SimpleIO.Resources.Designator = (chip : 1; channel :  0);  { GPIO18, GPIO19, GPIO20; and GPIO21 }
  SPI1_1 : IO.Objects.SimpleIO.Resources.Designator = (chip : 1; channel :  1);  { GPIO17, GPIO19, GPIO20; and GPIO21 }
  SPI1_2 : IO.Objects.SimpleIO.Resources.Designator = (chip : 1; channel :  2);  { GPIO16, GPIO19, GPIO20; and GPIO21 }

end.