hal.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
/*!****************************************************************************
 *  @file       hal.h
 *  @brief      Brushed Motor Driver Library HAL Module
 *  @defgroup   BSM__MSPM0C_HAL LP_MSPM0C1106 - Hardware Abstraction Layer (HAL)
 *  
 *
 *  @anchor bsm_lp_mpsm0c1106_hal_Overview
 *  # Overview
 * 
 *  The HAL module provides micro-controller agnostic set of application
 *  programming interfaces (APIs) to be used by other module's in the library
 *  as well as in the user's application code.
 *
 *  <hr>
 ******************************************************************************/
#ifndef bsm_lp_mpsm0c1106_hal_h
#define bsm_lp_mpsm0c1106_hal_h

#include "ti_msp_dl_config.h"
#include <ti/iqmath/include/IQmathLib.h>

#ifdef __cplusplus
extern "C" {
#endif

#define HIGH    (PIN_MODE_OUTPUT_HIGH)

#define LOW     (PIN_MODE_OUTPUT_LOW)

typedef enum {
    PIN_MODE_OUTPUT_LOW = 0,
    PIN_MODE_OUTPUT_HIGH,
    PIN_MODE_INPUT_PU,
    PIN_MODE_INPUT_PD,
    PIN_MODE_INPUT_HZ,
    PIN_MODE_PERIPHERAL,
    PIN_MODE_MAX
} PIN_MODE;

typedef enum {
    PWM_CHANNEL_0 = 0,
    PWM_CHANNEL_1,
    PWM_CHANNELS_MAX
} PWM_CHANNELS;

typedef enum {
    SPI_CHANNEL_0 = 0,
    SPI_CHANNELS_MAX
} SPI_CHANNELS;

typedef enum {
    SPI_CS_0 = 0,
    SPI_CS_1,
    SPI_CS_2,
    SPI_CS_3,
    SPI_CS_MAX
} SPI_CS;

typedef enum {
    GPIO_OUTPUT_PIN_0 = 0,
    GPIO_OUTPUT_PIN_1,
    GPIO_OUTPUT_PIN_2,
    GPIO_OUTPUT_PIN_3,
    GPIO_OUTPUT_PIN_4,
    GPIO_OUTPUT_PINS_MAX
} GPIO_OUTPUT_PINS;

typedef enum {
    GPIO_INPUT_PIN_0 = 0,
    GPIO_INPUT_PINS_MAX
} GPIO_INPUT_PINS;

typedef enum {
    ADC_CHAN_0 = 0,
    ADC_CHAN_1,
    ADC_CHANS_MAX
} ADC_CHANS;

void HAL_setDutyCycle(PWM_CHANNELS pwmChan,uint8_t targetDutyCycle);

void HAL_setPWMFreq(PWM_CHANNELS pwmChan, uint32_t targetFreq);

void HAL_configurePWMPin(PWM_CHANNELS pwmChan,PIN_MODE mode);

void HAL_writeSPI8withTimeout(SPI_CHANNELS spi_chan,
                              SPI_CS cs_chan,
                              uint8_t data,
                              uint32_t timeout);

uint8_t HAL_readSPI8withTimeout(SPI_CHANNELS spi_chan,
                                SPI_CS cs_chan,
                                uint32_t timeout);

void HAL_writeSPI16withTimeout(SPI_CHANNELS spi_chan,
                               SPI_CS cs_chan,
                               uint16_t data,
                               int32_t timeout);

uint16_t HAL_readSPI16withTimeout(SPI_CHANNELS spi_chan,
                                  SPI_CS cs_chan,
                                  int32_t timeout);

void HAL_delayMicroSeconds(uint32_t num_us);

void HAL_delayMilliSeconds(uint32_t num_us);

bool HAL_readGPIOInput(GPIO_INPUT_PINS pin);

void HAL_setGPIOOutput(GPIO_OUTPUT_PINS pin,PIN_MODE mode);

void HAL_Init();

void HAL_setADCRefVoltage(ADC_CHANS adcChan, uint16_t voltage_mV);

uint16_t HAL_getRawADCValue(ADC_CHANS adcChan);

uint32_t HAL_getmVfromADC(ADC_CHANS adcChan);

_iq20 HAL_getIQ20VoltageFromADC(ADC_CHANS adcChan);

DL_ADC12_IIDX HAL_processADCIRQ(ADC12_Regs *adcInst);

#ifdef __cplusplus
}
#endif

#endif