circuitpython/supervisor/shared/board.c

/*
 * This file is part of the MicroPython project, http://micropython.org/
 *
 * The MIT License (MIT)
 *
 * Copyright (c) 2020 Dan Halbert for Adafruit Industries
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

#include "supervisor/board.h"
#include "supervisor/shared/board.h"

#if CIRCUITPY_DIGITALIO && CIRCUITPY_NEOPIXEL_WRITE

#include <string.h>

#include "shared-bindings/digitalio/DigitalInOut.h"
#include "shared-bindings/neopixel_write/__init__.h"

void board_reset_user_neopixels(const mcu_pin_obj_t *pin, size_t count) {
    // Turn off on-board NeoPixel string
    uint8_t empty[count * 3];
    memset(empty, 0, count * 3);
    digitalio_digitalinout_obj_t neopixel_pin;
    common_hal_digitalio_digitalinout_construct(&neopixel_pin, pin);
    common_hal_digitalio_digitalinout_switch_to_output(&neopixel_pin, false,
        DRIVE_MODE_PUSH_PULL);
    common_hal_neopixel_write(&neopixel_pin, empty, count * 3);
    common_hal_digitalio_digitalinout_deinit(&neopixel_pin);
}

#endif

// Do-nothing so not all boards need to provide this function.
MP_WEAK bool board_requests_safe_mode(void) {
    return false;
}

// Do-nothing so not all boards need to provide this function.
MP_WEAK void board_init(void) {
}

// Do-nothing so not all boards need to provide this function.
MP_WEAK void board_deinit(void) {
}

// Do-nothing so not all boards need to provide this function.
MP_WEAK void reset_board(void) {
}