SysConnectors.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 __SYSCONNECTORS_H__
#define __SYSCONNECTORS_H__


#ifdef __cplusplus
extern "C" {
#endif

#define HBRIDGE_CON_CNT  (2)

#define MOTOR_CON_CNT (4)

typedef enum {
    CLEARCORE_PIN_INVALID = -1, 
    CLEARCORE_PIN_IO0,  
    CLEARCORE_PIN_IO1,  
    CLEARCORE_PIN_IO2,  
    CLEARCORE_PIN_IO3,  
    CLEARCORE_PIN_IO4,  
    CLEARCORE_PIN_IO5,  
    CLEARCORE_PIN_DI6,  
    CLEARCORE_PIN_DI7,  
    CLEARCORE_PIN_DI8,  
    CLEARCORE_PIN_A9,   
    CLEARCORE_PIN_A10,  
    CLEARCORE_PIN_A11,  
    CLEARCORE_PIN_A12,  
    CLEARCORE_PIN_LED,  
    CLEARCORE_PIN_M0,   
    CLEARCORE_PIN_M1,   
    CLEARCORE_PIN_M2,   
    CLEARCORE_PIN_M3,   
    CLEARCORE_PIN_COM0, 
    CLEARCORE_PIN_COM1, 
    CLEARCORE_PIN_USB,  
    CLEARCORE_PIN_MAX,  
    // Motor inputs
    CLEARCORE_PIN_M0_INA,   
    CLEARCORE_PIN_M1_INA,   
    CLEARCORE_PIN_M2_INA,   
    CLEARCORE_PIN_M3_INA,   
    CLEARCORE_PIN_M0_INB,   
    CLEARCORE_PIN_M1_INB,   
    CLEARCORE_PIN_M2_INB,   
    CLEARCORE_PIN_M3_INB,   
    // CCIO-8 Pins
    CLEARCORE_PIN_CCIO_BASE = 64,
    CLEARCORE_PIN_CCIOA0 = CLEARCORE_PIN_CCIO_BASE, 
    CLEARCORE_PIN_CCIOA1,   
    CLEARCORE_PIN_CCIOA2,   
    CLEARCORE_PIN_CCIOA3,   
    CLEARCORE_PIN_CCIOA4,   
    CLEARCORE_PIN_CCIOA5,   
    CLEARCORE_PIN_CCIOA6,   
    CLEARCORE_PIN_CCIOA7,   
    CLEARCORE_PIN_CCIOB0,   
    CLEARCORE_PIN_CCIOB1,   
    CLEARCORE_PIN_CCIOB2,   
    CLEARCORE_PIN_CCIOB3,   
    CLEARCORE_PIN_CCIOB4,   
    CLEARCORE_PIN_CCIOB5,   
    CLEARCORE_PIN_CCIOB6,   
    CLEARCORE_PIN_CCIOB7,   
    CLEARCORE_PIN_CCIOC0,   
    CLEARCORE_PIN_CCIOC1,   
    CLEARCORE_PIN_CCIOC2,   
    CLEARCORE_PIN_CCIOC3,   
    CLEARCORE_PIN_CCIOC4,   
    CLEARCORE_PIN_CCIOC5,   
    CLEARCORE_PIN_CCIOC6,   
    CLEARCORE_PIN_CCIOC7,   
    CLEARCORE_PIN_CCIOD0,   
    CLEARCORE_PIN_CCIOD1,   
    CLEARCORE_PIN_CCIOD2,   
    CLEARCORE_PIN_CCIOD3,   
    CLEARCORE_PIN_CCIOD4,   
    CLEARCORE_PIN_CCIOD5,   
    CLEARCORE_PIN_CCIOD6,   
    CLEARCORE_PIN_CCIOD7,   
    CLEARCORE_PIN_CCIOE0,   
    CLEARCORE_PIN_CCIOE1,   
    CLEARCORE_PIN_CCIOE2,   
    CLEARCORE_PIN_CCIOE3,   
    CLEARCORE_PIN_CCIOE4,   
    CLEARCORE_PIN_CCIOE5,   
    CLEARCORE_PIN_CCIOE6,   
    CLEARCORE_PIN_CCIOE7,   
    CLEARCORE_PIN_CCIOF0,   
    CLEARCORE_PIN_CCIOF1,   
    CLEARCORE_PIN_CCIOF2,   
    CLEARCORE_PIN_CCIOF3,   
    CLEARCORE_PIN_CCIOF4,   
    CLEARCORE_PIN_CCIOF5,   
    CLEARCORE_PIN_CCIOF6,   
    CLEARCORE_PIN_CCIOF7,   
    CLEARCORE_PIN_CCIOG0,   
    CLEARCORE_PIN_CCIOG1,   
    CLEARCORE_PIN_CCIOG2,   
    CLEARCORE_PIN_CCIOG3,   
    CLEARCORE_PIN_CCIOG4,   
    CLEARCORE_PIN_CCIOG5,   
    CLEARCORE_PIN_CCIOG6,   
    CLEARCORE_PIN_CCIOG7,   
    CLEARCORE_PIN_CCIOH0,   
    CLEARCORE_PIN_CCIOH1,   
    CLEARCORE_PIN_CCIOH2,   
    CLEARCORE_PIN_CCIOH3,   
    CLEARCORE_PIN_CCIOH4,   
    CLEARCORE_PIN_CCIOH5,   
    CLEARCORE_PIN_CCIOH6,   
    CLEARCORE_PIN_CCIOH7,   
    CLEARCORE_PIN_CCIO_MAX,
} ClearCorePins;

#ifdef __cplusplus
} // extern "C"
#endif

#ifdef __cplusplus

namespace ClearCore {

union SysConnectorState {
    SysConnectorState(uint32_t initialBits) : reg(initialBits) {}
    SysConnectorState() : reg(0) {}

    uint32_t reg;
    struct {
        // Matched to ClearCorePins enum.
        uint32_t CLEARCORE_PIN_IO0 : 1;
        uint32_t CLEARCORE_PIN_IO1 : 1;
        uint32_t CLEARCORE_PIN_IO2 : 1;
        uint32_t CLEARCORE_PIN_IO3 : 1;
        uint32_t CLEARCORE_PIN_IO4 : 1;
        uint32_t CLEARCORE_PIN_IO5 : 1;
        uint32_t CLEARCORE_PIN_DI6 : 1;
        uint32_t CLEARCORE_PIN_DI7 : 1;
        uint32_t CLEARCORE_PIN_DI8 : 1;
        uint32_t CLEARCORE_PIN_A9 : 1;
        uint32_t CLEARCORE_PIN_A10 : 1;
        uint32_t CLEARCORE_PIN_A11 : 1;
        uint32_t CLEARCORE_PIN_A12 : 1;
        uint32_t CLEARCORE_PIN_LED : 1;
        uint32_t CLEARCORE_PIN_M0 : 1;
        uint32_t CLEARCORE_PIN_M1 : 1;
        uint32_t CLEARCORE_PIN_M2 : 1;
        uint32_t CLEARCORE_PIN_M3 : 1;
        uint32_t CLEARCORE_PIN_COM0 : 1;
        uint32_t CLEARCORE_PIN_COM1 : 1;
        uint32_t CLEARCORE_PIN_USB : 1;
    } bit;
};

} // ClearCore namespace
#endif // defined(__cplusplus)

#endif // !__SYSCONNECTORS_H__