EK-TM4C123GXL: ADC on TI-RTOS

/*
 * ADC.c
 *
 *  Created on: 10 feb 2023
 *      Author: marika
 */

/*
 * Copyright (c) 2016-2019, 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.
 */
/*
 *  ======== ADC.c ========
 */

#include <stdbool.h>
#include <stdint.h>
#include <stdlib.h>

#include <myADC.h>
#include <myADCTiva.h>
#include <driverlib/adc.h>


/* Externs */
extern const ADC_Config ADC_config[];

/* Used to check status and initialization */
static int ADC_count= -1;


/* Default ADC parameters structure */
const ADC_Params ADC_defaultParams = {//TO CHECK
      (uintptr_t) NULL    /* custom */
};



/*
 *  ======== ADC_close ========
 */
void ADC_close(ADC_Handle handle)
{
    handle->fxnTablePtr->closeFxn(handle);
}

/*
 *  ======== ADC_control ========
 */
int ADC_control(ADC_Handle handle, unsigned int cmd, void *arg)
{
    return (handle->fxnTablePtr->controlFxn(handle, cmd, arg));
}


/*
 *  ======== ADC_init ========
 */
void ADC_init(void)
{
   if (ADC_count == -1) {
            /* Call each driver's init function */
            for (ADC_count = 0; ADC_config[ADC_count].fxnTablePtr != NULL; ADC_count++) {
                ADC_config[ADC_count].fxnTablePtr->initFxn((ADC_Handle)&(ADC_config[ADC_count]));
            }
        }
}

/*
 *  ======== ADC_open ========
 */
ADC_Handle ADC_open(unsigned int index, ADC_Params *params)
{
       ADC_Handle         handle;

        if (index >= ADC_count) {
            return (NULL);
        }

        /* If params are NULL use defaults */
        if (params == NULL) {
            params = (ADC_Params *) &ADC_defaultParams;
        }

        /* Get handle for this driver instance */
        handle = (ADC_Handle)&(ADC_config[index]);

        return (handle->fxnTablePtr->openFxn(handle, params));

}

/*
 *  ======== ADC_Params_init ========
 */
void ADC_Params_init(ADC_Params *params)
{
    *params = ADC_defaultParams;
}

/*
 * myADCTiva.c
 *
 *  Created on: 14 feb 2023
 *      Author: nicol
 */
#include <stdint.h>
#include <stdbool.h>
#include <stdlib.h>

#include <xdc/runtime/Assert.h>
#include <xdc/runtime/Diags.h>
#include <xdc/runtime/Error.h>
#include <xdc/runtime/Log.h>
#include <xdc/runtime/System.h>
#include <xdc/runtime/Types.h>

#include <myADCTiva.h>

#include <ti/sysbios/BIOS.h>
#include <ti/sysbios/knl/Semaphore.h>
#include <ti/sysbios/family/arm/m3/Hwi.h>

#include <inc/hw_memmap.h>
#include <inc/hw_ints.h>
#include <inc/hw_types.h>
#include <driverlib/adc.h>
#include <inc/hw_sysctl.h>
#include <driverlib/sysctl.h>

/* ADCTiva functions */
void ADCTiva_close(ADC_Handle handle);
int ADCTiva_control(ADC_Handle handle, unsigned int cmd, void *arg);
void ADCTiva_init(ADC_Handle handle);
ADC_Handle ADCTiva_open(ADC_Handle handle, ADC_Params *params);

/* ADC function table for ADCTiva implementation */
const ADC_FxnTable ADCTiva_fxnTable = {
    ADCTiva_close,
    ADCTiva_control,
    ADCTiva_init,
    ADCTiva_open

};

/*
 *  ======== ADCTiva_close ========
 */
void ADCTiva_close(ADC_Handle handle){

    ADCTiva_Object             *object = handle->object;
    ADCTiva_HWAttrs const      *hwAttrs = handle->hwAttrs;

    /* Disable ADC and interrupts. */
    ADCIntDisable(hwAttrs->baseAddr, 0);
    ADCSequenceDisable(hwAttrs->baseAddr, 0);

    Hwi_destruct(&(object->hwi));
    Semaphore_destruct(&(object->adcSem));

    object->isOpen = false;

    Log_print1(Diags_USER1, "ADC:(%p) closed", hwAttrs->baseAddr);


}

/*
 *  ======== ADCCTiva_control ========
 *  @pre    Function assumes that the handle is not NULL
 */
int ADCTiva_control(ADC_Handle handle, unsigned int cmd, void *arg)
{
    /* No implementation yet */
    return (ADC_STATUS_UNDEFINEDCMD);
}

/*
 *  ======== ADCTiva_hwiFxn ========
 *  Hwi interrupt handler to service the ADC peripheral
 *
 *  The handler is a generic handler for a ADC object.
 */
static void ADCTiva_hwiFxn(UArg arg){

    /* Get the pointer to the object and hwAttrs */
        ADCTiva_Object         *object = ((ADC_Handle)arg)->object;
        ADCTiva_HWAttrs const  *hwAttrs = ((ADC_Handle)arg)->hwAttrs;
//        uint32_t                status;

        /* Clear interrupts */
//        status=ADCIntStatus(hwAttrs->baseAddr, 0,true);
        object->isOpen = false;

        ADCIntClear(hwAttrs->baseAddr, 0);
        ADCSequenceDataGet(ADC0_BASE, 0, &Value);

}

/*
 *  ======== ADCTiva_init ========
 */
void ADCTiva_init(ADC_Handle handle)
{
    /* Mark the object as available */
    ((ADCTiva_Object *) (handle->object))->isOpen = false;
}

/*
 *  ======== ADCTiva_open ========
 */
ADC_Handle ADCTiva_open(ADC_Handle handle, ADC_Params *params)
{
    unsigned int               key;
    ADCTiva_Object             *object = handle->object;
    ADCTiva_HWAttrs const      *hwAttrs = handle->hwAttrs;
    union {
        Semaphore_Params        semParams;
        Hwi_Params              hwiParams;
    } paramsUnion;

    /* Determine if the device index was already opened */
    key = Hwi_disable();
    if(object->isOpen == true){
        Hwi_restore(key);
        Log_warning1("ADC:(%p) already in use.", hwAttrs->baseAddr);
        return (NULL);
    }

    /* Mark the handle as being used */
    object->isOpen = true;
    Hwi_restore(key);

    /* Create Hwi object for this I2C peripheral */
    Hwi_Params_init(&(paramsUnion.hwiParams));
    paramsUnion.hwiParams.arg = (UArg)handle;
    paramsUnion.hwiParams.priority = hwAttrs->intPriority;
    Hwi_construct(&(object->hwi), hwAttrs->intNum, ADCTiva_hwiFxn,
                  &(paramsUnion.hwiParams), NULL);

    /*
     * Create threadsafe handles for this I2C peripheral
     * Semaphore to provide exclusive access to the I2C peripheral
     */
    Semaphore_Params_init(&(paramsUnion.semParams));
    paramsUnion.semParams.mode = Semaphore_Mode_BINARY;
    Semaphore_construct(&(object->adcSem), 1, &(paramsUnion.semParams));

    ADCIntClear(hwAttrs->baseAddr, 0);

    ADCSequenceEnable(hwAttrs->baseAddr, 0);

    ADCIntEnable(hwAttrs->baseAddr, 0);


    /* Return the address of the handle */
    return (handle);

}