DAC.h

Go to the documentation of this file.

/*
 * Copyright (c) 2021, 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       DAC.h
 *  @brief      Digital to Analog Conversion (DAC) Output Driver
 *
 *  @anchor ti_drivers_DAC_Overview
 *  # Overview
 *
 *  The DAC driver allows you to manage a Digital to Analog peripheral via
 *  simple and portable APIs. This driver supports converting DAC codes
 *  into an analog voltage with varying degrees of precision (microvolts
 *  or millivolts) depending on the resolution of the DAC.
 *
 *  <hr>
 *  @anchor ti_drivers_DAC_Usage
 *  # Usage
 *
 *  This documentation provides a basic @ref ti_drivers_DAC_Synopsis
 *  "usage summary" and a set of @ref ti_drivers_DAC_Examples "examples"
 *  in the form of commented code fragments. Detailed descriptions of the
 *  APIs are provided in subsequent sections.
 *
 *  @anchor ti_drivers_DAC_Synopsis
 *  ## Synopsis
 *  @anchor ti_drivers_DAC_Synopsis_Code
 *  @code
 *  // Import DAC Driver definitions
 *  #include <ti/drivers/DAC.h>
 *
 *  // Define name for DAC channel index
 *  #define VREFERENCE_OUT  0
 *
 *  // One-time init of DAC driver
 *  DAC_init();
 *
 *  // Initialize optional DAC parameters
 *  DAC_Params params;
 *  DAC_Params_init(&params);
 *
 *  // Open DAC channels for usage
 *  DAC_Handle dacHandle = DAC_open(VREFERENCE_OUT, &params);

 *  // Enable the DAC channel
 *  DAC_enable(dacHandle);
 *
 *  // Output 800mV using the DAC
 *  DAC_setVoltage(dacHandle, 800000);
 *
 *  // Output a voltage using DAC codes
 *  DAC_setCode(dacHandle, 125);
 *
 *  // Disable the DAC channel
 *  DAC_disable(dacHandle);
 *
 *  // Close the DAC channel
 *  DAC_close(dacHandle);
 *
 *  @endcode
 *
 *  <hr>
 *  @anchor ti_drivers_DAC_Examples
 *  # Examples
 *
 *  @li @ref ti_drivers_DAC_Examples_open "Opening a DAC instance"
 *  @li @ref ti_drivers_DAC_Examples_reference "Using DAC to set a reference voltage"
 *  @li @ref ti_drivers_DAC_Examples_code "Using DAC to set a code"
 *
 *  @anchor ti_drivers_DAC_Examples_open
 *  ## Opening a DAC instance
 *
 *  @code
 *  DAC_Handle dac;
 *  DAC_Params params;
 *
 *  DAC_Params_init(&params);
 *
 *  dac = DAC_open(0, &params);
 *  if (dac == NULL) {
 *      // DAC_open() failed
 *      while (1) {}
 *  }
 *  @endcode
 *
 *  @anchor ti_drivers_DAC_Examples_reference
 *  ## Using DAC to set a reference voltage
 *
 *  To set a reference voltage first enable the DAC with DAC_enable()
 *  and then set the desired output voltage with DAC_setVoltage().
 *  The returned value can be used to check if the call was successful.
 *
 *  @code
 *  int_fast16_t res;
 *  uint32_t outputMicroVolts = 1500000;
 *
 *  DAC_enable(dac);
 *  res = DAC_setVoltage(dac, outputMicroVolts);
 *  if (res == DAC_STATUS_SUCCESS)
 *  {
 *      printf(outputMicroVolts);
 *  }
 *  @endcode
 *
 *  @anchor ti_drivers_DAC_Examples_code
 *  ## Using DAC to set a code
 *
 *  The following example shows how to set a DAC code. The use of DAC_setCode()
 *  instead of DAC_setVoltage() comes handy in scenarios such as outputting a
 *  data buffer at a particular time rate (e.g. waveform generation). Nevertheless,
 *  it's important to remember that DAC codes produce different output voltages
 *  depending on the selected voltage reference source.
 *
 *  @code
 *  int_fast16_t res;
 *  uint32_t outputCode = 127;
 *  DAC_enable(dac);
 *  res = DAC_setCode(dac, outputCode);
 *  if (res == DAC_STATUS_SUCCESS)
 *  {
 *      printf(outputCode);
 *  }
 *  @endcode
 *
 *  <hr>
 *  @anchor ti_drivers_DAC_Configuration
 *  # Configuration
 *
 *  Refer to the @ref driver_configuration "Driver's Configuration" section
 *  for driver configuration information.
 *  <hr>
 ******************************************************************************
 */

#ifndef ti_drivers_DAC__include
#define ti_drivers_DAC__include

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

#include <ti/devices/DeviceFamily.h>
#include DeviceFamily_constructPath(driverlib/aux_dac.h)

#ifdef __cplusplus
extern "C" {
#endif

#define DAC_STATUS_SUCCESS (0)

#define DAC_STATUS_ERROR (-1)

#define DAC_STATUS_INUSE (-2)

#define DAC_STATUS_INVALID (-3)

typedef struct
{
    void *object;
    void const *hwAttrs;
} DAC_Config;

typedef DAC_Config *DAC_Handle;

typedef struct
{
    uint32_t initCode;
    void *custom;
} DAC_Params;

extern const DAC_Params DAC_defaultParams;

extern void DAC_init(void);

extern DAC_Handle DAC_open(uint_least8_t index, DAC_Params *params);

extern void DAC_close(DAC_Handle handle);

extern int_fast16_t DAC_setVoltage(DAC_Handle handle, uint32_t uVoltOutput);

extern int_fast16_t DAC_setCode(DAC_Handle handle, uint32_t code);

extern int_fast16_t DAC_enable(DAC_Handle handle);

extern int_fast16_t DAC_disable(DAC_Handle handle);

extern void DAC_Params_init(DAC_Params *params);

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_DAC__include */