001package com.pi4j.io.gpio;
002
003/*
004 * #%L
005 * **********************************************************************
006 * ORGANIZATION  :  Pi4J
007 * PROJECT       :  Pi4J :: Java Library (Core)
008 * FILENAME      :  RCMPin.java
009 *
010 * This file is part of the Pi4J project. More information about
011 * this project can be found here:  https://www.pi4j.com/
012 * **********************************************************************
013 * %%
014 * Copyright (C) 2012 - 2021 Pi4J
015 * %%
016 * This program is free software: you can redistribute it and/or modify
017 * it under the terms of the GNU Lesser General Public License as
018 * published by the Free Software Foundation, either version 3 of the
019 * License, or (at your option) any later version.
020 *
021 * This program is distributed in the hope that it will be useful,
022 * but WITHOUT ANY WARRANTY; without even the implied warranty of
023 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
024 * GNU General Lesser Public License for more details.
025 *
026 * You should have received a copy of the GNU General Lesser Public
027 * License along with this program.  If not, see
028 * <http://www.gnu.org/licenses/lgpl-3.0.html>.
029 * #L%
030 */
031
032/**
033 * Raspberry Pi Compute Module pin definitions.
034 *
035 * This pin provider should be used for Raspberry Pi models:
036 *  - RaspberryPi CM
037 *  - RaspberryPi CM3
038 *  - RaspberryPi CM3 Lite
039 *  - RaspberryPi CM3+
040 *
041 * NOTE:  Unlike the older models, the Raspberry Pi CM4 only exposes 28 GPIO pins which correspond to the
042 *        GPIO pins on the Raspberry Pi 4.  Thus for the CM4 you should not use the RCMPin pin provider,
043 *        but rather use the traditional 'RaspiPin' pin provider just like you would for a RPi 4B.
044 *
045 * @author Robert Savage (<a
046 *         href="http://www.savagehomeautomation.com">http://www.savagehomeautomation.com</a>)
047 *
048 *  For PWM pin definitions see: http://elinux.org/RPi_BCM2835_GPIOs
049 */
050@SuppressWarnings("unused")
051public class RCMPin extends PinProvider {
052
053    public static final Pin GPIO_00 = createDigitalPin(0, "GPIO 0");
054    public static final Pin GPIO_01 = createDigitalPin(1, "GPIO 1");
055    public static final Pin GPIO_02 = createDigitalPin(2, "GPIO 2");
056    public static final Pin GPIO_03 = createDigitalPin(3, "GPIO 3");
057    public static final Pin GPIO_04 = createDigitalPin(4, "GPIO 4");
058    public static final Pin GPIO_05 = createDigitalPin(5, "GPIO 5");
059    public static final Pin GPIO_06 = createDigitalPin(6, "GPIO 6");
060    public static final Pin GPIO_07 = createDigitalPin(7, "GPIO 7");
061    public static final Pin GPIO_08 = createDigitalPin(8, "GPIO 8");
062    public static final Pin GPIO_09 = createDigitalPin(9, "GPIO 9");
063    public static final Pin GPIO_10 = createDigitalPin(10, "GPIO 10");
064    public static final Pin GPIO_11 = createDigitalPin(11, "GPIO 11");
065    public static final Pin GPIO_12 = createDigitalAndPwmPin(12, "GPIO 12"); // supports PWM0 [ALT0]
066    public static final Pin GPIO_13 = createDigitalAndPwmPin(13, "GPIO 13"); // supports PWM1 [ALT0]
067    public static final Pin GPIO_14 = createDigitalPin(14, "GPIO 14");
068    public static final Pin GPIO_15 = createDigitalPin(15, "GPIO 15");
069    public static final Pin GPIO_16 = createDigitalPin(16, "GPIO 16");
070    public static final Pin GPIO_17 = createDigitalPin(17, "GPIO 17");
071    public static final Pin GPIO_18 = createDigitalAndPwmPin(18, "GPIO 18"); // supports PWM0 [ALT5]
072    public static final Pin GPIO_19 = createDigitalAndPwmPin(19, "GPIO 19"); // supports PWM1 [ALT5]
073    public static final Pin GPIO_20 = createDigitalPin(20, "GPIO 20");
074    public static final Pin GPIO_21 = createDigitalPin(21, "GPIO 21");
075    public static final Pin GPIO_22 = createDigitalPin(22, "GPIO 22");
076    public static final Pin GPIO_23 = createDigitalPin(23, "GPIO 23");
077    public static final Pin GPIO_24 = createDigitalPin(24, "GPIO 24");
078    public static final Pin GPIO_25 = createDigitalPin(25, "GPIO 25");
079    public static final Pin GPIO_26 = createDigitalPin(26, "GPIO 26");
080    public static final Pin GPIO_27 = createDigitalPin(27, "GPIO 27");
081    public static final Pin GPIO_28 = createDigitalPin(28, "GPIO 28");
082    public static final Pin GPIO_29 = createDigitalPin(29, "GPIO 29");
083    public static final Pin GPIO_30 = createDigitalPin(30, "GPIO 30");
084    public static final Pin GPIO_31 = createDigitalPin(31, "GPIO 31");
085    public static final Pin GPIO_32 = createDigitalPin(32, "GPIO 32");
086    public static final Pin GPIO_33 = createDigitalPin(33, "GPIO 33");
087    public static final Pin GPIO_34 = createDigitalPin(34, "GPIO 34");
088    public static final Pin GPIO_35 = createDigitalPin(35, "GPIO 35");
089    public static final Pin GPIO_36 = createDigitalPin(36, "GPIO 36");
090    public static final Pin GPIO_37 = createDigitalPin(37, "GPIO 37");
091    public static final Pin GPIO_38 = createDigitalPin(38, "GPIO 38");
092    public static final Pin GPIO_39 = createDigitalPin(39, "GPIO 39");
093    public static final Pin GPIO_40 = createDigitalAndPwmPin(40, "GPIO 40"); // supports PWM0 [ALT0]
094    public static final Pin GPIO_41 = createDigitalAndPwmPin(41, "GPIO 41"); // supports PWM1 [ALT0]
095    public static final Pin GPIO_42 = createDigitalPin(42, "GPIO 42");
096    public static final Pin GPIO_43 = createDigitalPin(43, "GPIO 43");
097    public static final Pin GPIO_44 = createDigitalPin(44, "GPIO 44");
098    public static final Pin GPIO_45 = createDigitalAndPwmPin(45, "GPIO 45"); // supports PWM1 [ALT0]
099
100    protected static Pin createDigitalPin(int address, String name) {
101        return createDigitalPin(RaspiGpioProvider.NAME, address, name);
102    }
103
104    protected static Pin createDigitalAndPwmPin(int address, String name) {
105        return createDigitalAndPwmPin(RaspiGpioProvider.NAME, address, name);
106    }
107
108    // *override* static method from subclass
109    // (overriding a static method is not supported in Java
110    //  so this method definition will hide the subclass static method)
111    public static Pin getPinByName(String name) {
112        return PinProvider.getPinByName(name);
113    }
114
115    // *override* static method from subclass
116    // (overriding a static method is not supported in Java
117    //  so this method definition will hide the subclass static method)
118    public static Pin getPinByAddress(int address) {
119        return PinProvider.getPinByAddress(address);
120    }
121
122    // *override* static method from subclass
123    // (overriding a static method is not supported in Java
124    //  so this method definition will hide the subclass static method)
125    public static Pin[] allPins() { return PinProvider.allPins(); }
126}