VMXChannel.h

Go to the documentation of this file.

/* ============================================
VMX-pi HAL source code is placed under the MIT license
Copyright (c) 2017 Kauai Labs
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 VMXCHANNEL_H_
#define VMXCHANNEL_H_

#include <stdint.h>

/* Each VMXChannel has zero or more of the following Capabilities */
/* Some of these Capabilities are dynamic, and may be changed via
 * jumper (e.g., VMX PWM/DigInput jumper).  However, their state at the
 * beginning of the application will not change during the lifetime of the
 * application.
 *
 * When VMXChannel Capabilities refer to Shared Resources, there is no
 * guarantee that at any instant a VMXChannel can be configured with this,
 * as VMXChannels must be routed to resources w/sufficient availability
 * in order for the VMXChannel capability to be active.
 */

typedef enum {
    INVALID = 0,
    FlexDIO  = 1,
    AnalogIn = 2,
    HiCurrDIO = 3,
    CommDIO = 4
} VMXChannelType;

typedef enum {
    NoCapabilities      = 0x00000000,
    DigitalInput        = 0x00000001,
    DigitalOutput       = 0x00000002,
    PWMGeneratorOutput  = 0x00000004,
    PWMGeneratorOutput2     = 0x00000008,
    PWMCaptureInput     = 0x00000010,
    InputCaptureInput   = PWMCaptureInput,
    PWMCaptureInput2    = 0x00000020,
    InputCaptureInput2 = PWMCaptureInput2,
    EncoderAInput       = 0x00000040,
    EncoderBInput       = 0x00000080,
    AccumulatorInput    = 0x00000100,
    AnalogTriggerInput  = 0x00000200,
    InterruptInput      = 0x00000400,
    UART_TX         = 0x00000800,
    UART_RX         = 0x00001000,
    SPI_CLK         = 0x00002000,
    SPI_MISO        = 0x00004000,
    SPI_MOSI        = 0x00008000,
    SPI_CS          = 0x00010000,
    I2C_SDA         = 0x00020000,
    I2C_SCL         = 0x00040000,
    LEDArray_OneWire    = 0x00080000,
} VMXChannelCapability;

typedef uint8_t  VMXChannelIndex;

const VMXChannelIndex INVALID_VMX_CHANNEL_INDEX = 255;

struct VMXChannelInfo {
    VMXChannelIndex index;
    VMXChannelCapability capabilities;

    VMXChannelInfo() {
        index = INVALID_VMX_CHANNEL_INDEX;
        capabilities = VMXChannelCapability::NoCapabilities;
    }   
    VMXChannelInfo(VMXChannelIndex i, VMXChannelCapability c) {
        index = i;
        capabilities = c;
    }
    bool IsValid() {
        return (index != INVALID_VMX_CHANNEL_INDEX);
    }
};

#endif /* VMXCHANNEL_H_ */