# ASysCtl Module

The ASysCtl or Analog System Control driver provides functions to enable, disable and lock the temperature sensor on the device. It will also provide additional functionality if available for that device.

group `asysctl_api`

  Defines

  `ASYSCTL_VREFHIA` 0x1U

    VREFHIA.

  `ASYSCTL_VREFHIB` 0x2U

    VREFHIB.

  `ASYSCTL_VREFHIC` 0x4U

    VREFHIC.

  `ASYSCTL_CMPHNMUX_SELECT_1` 0x1U

    CMPHNMUX select 1.

  `ASYSCTL_CMPHNMUX_SELECT_2` 0x2U

    CMPHNMUX select 2.

  `ASYSCTL_CMPHNMUX_SELECT_3` 0x4U

    CMPHNMUX select 3.

  `ASYSCTL_CMPHNMUX_SELECT_4` 0x8U

    CMPHNMUX select 4.

  `ASYSCTL_CMPHNMUX_SELECT_5` 0x10U

    CMPHNMUX select 5.

  `ASYSCTL_CMPHNMUX_SELECT_6` 0x20U

    CMPHNMUX select 6.

  `ASYSCTL_CMPHNMUX_SELECT_7` 0x40U

    CMPHNMUX select 7.

  `ASYSCTL_CMPLNMUX_SELECT_1` 0x1U

    CMPLNMUX select 1.

  `ASYSCTL_CMPLNMUX_SELECT_2` 0x2U

    CMPLNMUX select 2.

  `ASYSCTL_CMPLNMUX_SELECT_3` 0x4U

    CMPLNMUX select 3.

  `ASYSCTL_CMPLNMUX_SELECT_4` 0x8U

    CMPLNMUX select 4.

  `ASYSCTL_CMPLNMUX_SELECT_5` 0x10U

    CMPLNMUX select 5.

  `ASYSCTL_CMPLNMUX_SELECT_6` 0x20U

    CMPLNMUX select 6.

  `ASYSCTL_CMPLNMUX_SELECT_7` 0x40U

    CMPLNMUX select 7.

  Enums

  enum `ASysCtl_CMPHPMuxSelect`

    ASysCtl_CMPHPMuxSelect used for function ASysCtl_selectCMPHPMux().

    Values:

    enumerator `ASYSCTL_CMPHPMUX_SELECT_1` = 0U

      CMPHPMUX select 1.

    enumerator `ASYSCTL_CMPHPMUX_SELECT_2` = 3U

      CMPHPMUX select 2.

    enumerator `ASYSCTL_CMPHPMUX_SELECT_3` = 6U

      CMPHPMUX select 3.

    enumerator `ASYSCTL_CMPHPMUX_SELECT_4` = 9U

      CMPHPMUX select 4.

    enumerator `ASYSCTL_CMPHPMUX_SELECT_5` = 12U

      CMPHPMUX select 5.

    enumerator `ASYSCTL_CMPHPMUX_SELECT_6` = 16U

      CMPHPMUX select 6.

    enumerator `ASYSCTL_CMPHPMUX_SELECT_7` = 19U

      CMPHPMUX select 7.

  enum `ASysCtl_CMPLPMuxSelect`

    ASysCtl_CMPLPMuxSelect used for function ASysCtl_selectCMPLPMux().

    Values:

    enumerator `ASYSCTL_CMPLPMUX_SELECT_1` = 0U

      CMPLPMUX select 1.

    enumerator `ASYSCTL_CMPLPMUX_SELECT_2` = 3U

      CMPLPMUX select 2.

    enumerator `ASYSCTL_CMPLPMUX_SELECT_3` = 6U

      CMPLPMUX select 3.

    enumerator `ASYSCTL_CMPLPMUX_SELECT_4` = 9U

      CMPLPMUX select 4.

    enumerator `ASYSCTL_CMPLPMUX_SELECT_5` = 12U

      CMPLPMUX select 5.

    enumerator `ASYSCTL_CMPLPMUX_SELECT_6` = 16U

      CMPLPMUX select 6.

    enumerator `ASYSCTL_CMPLPMUX_SELECT_7` = 19U

      CMPLPMUX select 7.

  Functions

  bool `ASysCtl_getInductorFaultStatus`(void)

    ASysCtl_getInductorFaultStatus & ASysCtl_getSwitchSequenceStatus used for function ASysCtl_enableDCDC().

    Gets the inductor status.

    This function returns the inductor status.

    Return

      Return value true indicates that the external inductor connected to DC-DC is functional. Return value of false indicates it is faulty or not connected.

  bool `ASysCtl_getSwitchSequenceStatus`(void)

    Gets the Switch Sequence Status.

    This function returns the Switch Sequence Status.

    Return

      Return value false indicates that the switch to DC-DC is not complete. Return value of true indicates it is complete.

  void `ASysCtl_enableTemperatureSensor`(void)

    Enable temperature sensor.

    This function enables the temperature sensor output to the ADC.

    Return

      None.

  void `ASysCtl_disableTemperatureSensor`(void)

    Disable temperature sensor.

    This function disables the temperature sensor output to the ADC.

    Return

      None.

  void `ASysCtl_setAnalogReferenceInternal`(uint16_t reference)

    Set the analog voltage reference selection to internal.

    The parameter

    reference can be a combination of the following values:
    Parameters

      - `reference`: is the analog reference.

    - ASYSCTL_VREFHIA

    - ASYSCTL_VREFHIB

    - ASYSCTL_VREFHIC

    Return

      None.

  void `ASysCtl_setAnalogReferenceExternal`(uint16_t reference)

    Set the analog voltage reference selection to external.

    The parameter

    reference can be a combination of the following values:
    Parameters

      - `reference`: is the analog reference.

    - ASYSCTL_VREFHIA

    - ASYSCTL_VREFHIB

    - ASYSCTL_VREFHIC

    Return

      None.

  void `ASysCtl_setAnalogReference2P5`(uint16_t reference)

    Set the internal analog voltage reference selection to 2.5V.

    The parameter

    reference can be a combination of the following values:
    Parameters

      - `reference`: is the analog reference.

    - ASYSCTL_VREFHIA

    - ASYSCTL_VREFHIB

    - ASYSCTL_VREFHIC

    Return

      None.

  void `ASysCtl_setAnalogReference1P65`(uint16_t reference)

    Set the internal analog voltage reference selection to 1.65V.

    The parameter

    reference can be a combination of the following values:
    Parameters

      - `reference`: is the analog reference.

    - ASYSCTL_VREFHIA

    - ASYSCTL_VREFHIB

    - ASYSCTL_VREFHIC

    Return

      None.

  bool `ASysCtl_enableDCDC`(void)

    Enable DC-DC.

    This function enables the DC-DC and checks if the enable was successful when switching from the VREG to the DC-DC .

    Return

      Return value true indicates that the DC-DC enable was successful when switching from the VREG to the DC-DC . Return value of false indicates that the DC-DC enable with switch failed.

    Note

      The internal DC-DC regulator is disabled by default. To use this supply, the device must power up initially with the internal LDO (VREG) and then transition to the internal DC-DC regulator.

  void `ASysCtl_disableDCDC`(void)

    Disable DC-DC.

    Return

      None.

  void `ASysCtl_selectCMPHNMux`(uint16_t select)

    Select the value for CMPHNMXSEL.

    The parameter

    select can be a bitwise OR of the below values:
    Parameters

      - `select`: is a combination of CMPHNMXSEL values.

    - ASYSCTL_CMPHNMUX_SELECT_1

    - ASYSCTL_CMPHNMUX_SELECT_2

    - ASYSCTL_CMPHNMUX_SELECT_3

    - ASYSCTL_CMPHNMUX_SELECT_4

    - ASYSCTL_CMPHNMUX_SELECT_5

    - ASYSCTL_CMPHNMUX_SELECT_6

    - ASYSCTL_CMPHNMUX_SELECT_7

    Return

      None.

  void `ASysCtl_selectCMPHNMuxValue`(uint16_t select, uint16_t value)

    Select the value for individual CMPxHNMXSEL.

    The parameter

    select can be one of the below values:
    Parameters

      - `select`: is the CMPxHNMXSEL to be set.

      - `value`: is 0 or 1.

    - ASYSCTL_CMPHNMUX_SELECT_1

    - ASYSCTL_CMPHNMUX_SELECT_2

    - ASYSCTL_CMPHNMUX_SELECT_3

    - ASYSCTL_CMPHNMUX_SELECT_4

    - ASYSCTL_CMPHNMUX_SELECT_5

    - ASYSCTL_CMPHNMUX_SELECT_6

    - ASYSCTL_CMPHNMUX_SELECT_7

    Return

      None.

  void `ASysCtl_selectCMPLNMux`(uint16_t select)

    Select the value for individual CMPxLNMXSEL.

    The parameter

    select can be the bitwise OR of the below values:
    Parameters

      - `select`: is a combination of CMPLNMXSEL values.

    - ASYSCTL_CMPLNMUX_SELECT_1

    - ASYSCTL_CMPLNMUX_SELECT_2

    - ASYSCTL_CMPLNMUX_SELECT_3

    - ASYSCTL_CMPLNMUX_SELECT_4

    - ASYSCTL_CMPLNMUX_SELECT_5

    - ASYSCTL_CMPLNMUX_SELECT_6

    - ASYSCTL_CMPLNMUX_SELECT_7

    Return

      None.

  void `ASysCtl_selectCMPLNMuxValue`(uint16_t select, uint16_t value)

    Select the value for CMPLNMXSEL.

    The parameter

    select can be one of the below values:
    Parameters

      - `select`: is the CMPxHNMXSEL to be set.

      - `value`: is 0 or 1.

    - ASYSCTL_CMPLNMUX_SELECT_1

    - ASYSCTL_CMPLNMUX_SELECT_2

    - ASYSCTL_CMPLNMUX_SELECT_3

    - ASYSCTL_CMPLNMUX_SELECT_4

    - ASYSCTL_CMPLNMUX_SELECT_5

    - ASYSCTL_CMPLNMUX_SELECT_6

    - ASYSCTL_CMPLNMUX_SELECT_7

    Return

      None.

  void `ASysCtl_selectCMPHPMux`(ASysCtl_CMPHPMuxSelect select, uint32_t value)

    Select the value for CMPHPMXSEL.

    This function is used to write a value to one mux select at a time. The parameter

    select can be one of the following values:
    Parameters

      - `select`: is of type ASysCtl_CMPHPMuxSelect.

      - `value`: is 0, 1, 2, 3, or 4.

    - ASYSCTL_CMPHPMUX_SELECT_1

    - ASYSCTL_CMPHPMUX_SELECT_2

    - ASYSCTL_CMPHPMUX_SELECT_3

    - ASYSCTL_CMPHPMUX_SELECT_4

    - ASYSCTL_CMPHPMUX_SELECT_5

    - ASYSCTL_CMPHPMUX_SELECT_6

    - ASYSCTL_CMPHPMUX_SELECT_7

    Return

      None.

  void `ASysCtl_selectCMPLPMux`(ASysCtl_CMPLPMuxSelect select, uint32_t value)

    Select the value for CMPLPMXSEL.

    This function is used to write a value to one mux select at a time. The parameter

    select can be one of the following values:
    Parameters

      - `select`: is of type ASysCtl_CMPLPMuxSelect.

      - `value`: is 0, 1, 2, 3, or 4.

    - ASYSCTL_CMPLPMUX_SELECT_1

    - ASYSCTL_CMPLPMUX_SELECT_2

    - ASYSCTL_CMPLPMUX_SELECT_3

    - ASYSCTL_CMPLPMUX_SELECT_4

    - ASYSCTL_CMPLPMUX_SELECT_5

    - ASYSCTL_CMPLPMUX_SELECT_6

    - ASYSCTL_CMPLPMUX_SELECT_7

    Return

      None.

  void `ASysCtl_lockTemperatureSensor`(void)

    Locks the temperature sensor control register.

    Return

      None.

  void `ASysCtl_lockANAREF`(void)

    Locks the analog reference control register.

    Return

      None.

  void `ASysCtl_lockVMON`(void)

    Locks the voltage monitor control register.

    Return

      None.

  void `ASysCtl_lockDCDC`(void)

    Locks the DCDC control register.

    Return

      None.

  void `ASysCtl_lockPGAADCINMux`(void)

    Locks the ADCIN control register.

    Return

      None.

  void `ASysCtl_lockCMPHPMux`(void)

    Locks the CMPHPMXSEL control register.

    Return

      None.

  void `ASysCtl_lockCMPLPMux`(void)

    Locks the CMPLPMXSEL control register.

    Return

      None.

  void `ASysCtl_lockCMPHNMux`(void)

    Locks the CMPHNMXSEL control register.

    Return

      None.

  void `ASysCtl_lockCMPLNMux`(void)

    Locks the CMPLNMXSEL control register.

    Return

      None.

  void `ASysCtl_lockVREG`(void)

    Locks the VREG control register.

    Return

      None.

The code for this module is contained in driverlib/asysctl.c, with driverlib/asysctl.h containing the API declarations for use by applications.