SysManager.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020 Teknic, Inc.
 *
 * 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.
 */

#ifndef __SYSMANAGER_H__
#define __SYSMANAGER_H__

#include <stddef.h>
#include <stdint.h>
#include "Connector.h"
#include "PeripheralRoute.h"
#include "SysConnectors.h"

#ifdef __cplusplus

namespace ClearCore {

#ifndef HIDE_FROM_DOXYGEN
typedef void (*voidFuncPtr)(void);
#endif

class SysManager {

public:
    typedef enum {
        RESET_NORMAL,
        RESET_TO_BOOTLOADER,
    } ResetModes;

#ifndef HIDE_FROM_DOXYGEN

    SysManager();

    void Initialize();

    bool Ready() {
        return m_readyForOperations;
    }
#endif

    Connector *ConnectorByIndex(ClearCorePins connectorIndex);

    void ResetBoard(ResetModes mode = RESET_NORMAL);

#ifndef HIDE_FROM_DOXYGEN
    // Ideally these would be private, but they need to be called from C
    // interrupt handler functions that can't be friends without putting them
    // in a namespace.
    void SysTickUpdate();
    void FastUpdate();
#endif

private:
    bool m_readyForOperations;

    void InitClocks();

    void UpdateFastImpl();

    void UpdateSlowImpl();

};     // SysManager

} // ClearCore namespace

#endif // defined(__cplusplus)
#endif // __SYSMANAGER_H__