keychron_qmk_firmware/drivers/usb2422.h

/* Copyright 2021 QMK
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
#pragma once

#include <stdbool.h>

#ifndef USB2422_ADDRESS
#    define USB2422_ADDRESS 0x58
#endif

#ifndef USB2422_VENDOR_ID
#    define USB2422_VENDOR_ID 0xFEED
#endif
#ifndef USB2422_PRODUCT_ID
#    define USB2422_PRODUCT_ID 0x0001
#endif
#ifndef USB2422_DEVICE_VER
#    define USB2422_DEVICE_VER 0x0001
#endif

#ifndef USB2422_MANUFACTURER
#    define USB2422_MANUFACTURER "QMK"
#endif
#ifndef USB2422_PRODUCT
#    define USB2422_PRODUCT "QMK Hub"
#endif

/** \brief Initialises the dependent subsystems */
void USB2422_init(void);

/** \brief Push configuration to the USB2422 device */
void USB2422_configure(void);

/** \brief Reset the chip (RESET_N)
 *
 * NOTE:
 * Depends on a valid USB2422_RESET_PIN configuration
 */
void USB2422_reset(void);

/** \brief Indicates the USB state of the hub (SUSP_IND)
 *
 * NOTE:
 * Depends on a valid USB2422_ACTIVE_PIN configuration
 */
bool USB2422_active(void);