peak-can-basic/src/main/java/peak/can/peak/basic/TPCANBaudrate.java

/* SPDX-License-Identifier: LGPL-2.1-only */
/*
 * $Id: TPCANBaudrate.java 7391 2020-08-10 08:32:30Z Fabrice $
 * @LastChange $Date: 2020-08-10 10:32:30 +0200 (Mon, 10 Aug 2020) $
 * 
 * PCANBasic JAVA Interface.
 *
 * Copyright (C) 2001-2020  PEAK System-Technik GmbH <www.peak-system.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 *
 * PCAN is a registered Trademark of PEAK-System Germany GmbH
 *
 * Author: 		 Jonathan Urban/Uwe Wilhelm/Fabrice Vergnaud
 * Contact:      <linux@peak-system.com>
 * Maintainer:   Fabrice Vergnaud <f.vergnaud@peak-system.com>
 */
package peak.can.basic;

/**
 * Baud rate codes = BTR0/BTR1 register values for the CAN controller. You can
 * define your own Baud rate with the BTROBTR1 register. Take a look at
 * www.peak-system.com for our free software "BAUDTOOL" to calculate the
 * BTROBTR1 register for every baudrate and sample point.
 */
public enum TPCANBaudrate {

    /**
     * 1 MBit/s
     */
    PCAN_BAUD_1M(0x0014, false),
    /**
     * 800 kBit/s
     */
    PCAN_BAUD_800K(0x0016, false),
    /**
     * 500 kBit/s
     */
    PCAN_BAUD_500K(0x001C, false),
    /**
     * 250 kBit/s
     */
    PCAN_BAUD_250K(0x011C, false),
    /**
     * 125 kBit/s
     */
    PCAN_BAUD_125K(0x031C, false),
    /**
     * 100 kBit/s
     */
    PCAN_BAUD_100K(0x432F, false),
    /**
     * 95,238 kBit/s
     */
    PCAN_BAUD_95K(0xC34E, false),
    /**
     * 83,33 kBit/s
     */
    PCAN_BAUD_83K(0x852B, false),
    /**
     * 50 kBit/s
     */
    PCAN_BAUD_50K(0x472F, false),
    /**
     * 47,619 kBit/s
     */
    PCAN_BAUD_47K(0x1414, false),
    /**
     * 33,333 kBit/s
     */
    PCAN_BAUD_33K(0x8B2F, false),
    /**
     * 20 kBit/s
     */
    PCAN_BAUD_20K(0x532F, false),
    /**
     * 10 kBit/s
     */
    PCAN_BAUD_10K(0x672F, false),
    /**
     * 5 kBit/s
     */
    PCAN_BAUD_5K(0x7F7F, false),
    /**
     * User
     */
    PCAN_BAUD_User0(0x0, true),
    /**
     * User
     */
    PCAN_BAUD_User1(0x0, true),
    /**
     * User
     */
    PCAN_BAUD_User2(0x0, true),
    /**
     * User
     */
    PCAN_BAUD_User3(0x0, true),
    /**
     * User
     */
    PCAN_BAUD_User4(0x0, true),
    /**
     * User
     */
    PCAN_BAUD_User5(0x0, true),
    /**
     * User
     */
    PCAN_BAUD_User6(0x0, true),
    /**
     * User
     */
    PCAN_BAUD_User7(0x0, true),
    /**
     * User
     */
    PCAN_BAUD_User8(0x0, true),
    /**
     * User
     */
    PCAN_BAUD_User9(0x0, true);

    private int value;
    private final boolean user;

    private TPCANBaudrate(int value, boolean user) {
        this.value = value;
        this.user = user;
    }

    /**
     * Returns the value of the baud rate code.
     * @return value of the baud rate code
     */
    public int getValue() {
        return this.value;
    }

    /**
     * Sets the user-defined value.
     * @param value Baud rate code
     */
    public void setValue(int value) {
        if (user) {
            this.value = value;
        }
    }

    /**
     * Clears the user-defined value
     */
    public void clearValue() {
        if (user) {
            this.value = 0;
        }
    }

    /**
     * Returns a TPCANBaudrate matching the corresponding Baud rate code
     * @param value Baud rate code
     * @return null or a TPCANBaudrate matching the Baud rate code
     */
    public static TPCANBaudrate valueOf(int value) {
        for (TPCANBaudrate rate : values()) {
            if (rate.getValue() == value) {
                return rate;
            }
        }
        for (TPCANBaudrate rate : values()) {
            if (rate.user && rate.getValue() == 0) {
                rate.value = value;
                return rate;
            }
        }
        return null;
    }
};