SLVAFT2A May   2024  – July 2024 TPS2HCS10-Q1

 

  1.   1
  2.   Abstract
  3.   Trademarks
  4. 1Software Ecosystem
  5. 2Platform Drivers
    1. 2.1 Driver Concept
    2. 2.2 Supported Platforms
    3. 2.3 Porting to Other Platforms
    4. 2.4 API Guide
      1. 2.4.1  tHCSResponseCode Union Reference
      2. 2.4.2  float_t HCS_convertCurrent (uint16_t rawValue, uint16_t ksnsVal, uint16_t snsRes)
      3. 2.4.3  float_t HCS_convertTemperature (uint16_t rawValue)
      4. 2.4.4  float_t HCS_convertVoltage (uint16_t rawValue)
      5. 2.4.5  tHCSResponseCode HCS_getChannelFaultStatus (uint8_t chanNum, uint16_t * fltStatus)
      6. 2.4.6  tHCSResponseCode HCS_getDeviceFaultSatus (uint16_t * fltStatus)
      7. 2.4.7  tHCSResponseCode HCS_gotoLPM (lpm_exit_curr_ch1_t ch1ExitCurrent, lpm_exit_curr_ch2_t ch2ExitCurrent)
      8. 2.4.8  tHCSResponseCode HCS_gotoSleep (void )
      9. 2.4.9  tHCSResponseCode HCS_initializeDevice (TPS2HCS10Q1_CONFIG * config)
      10. 2.4.10 tHCSResponseCode HCS_readRegister (uint8_t addr, uint16_t * readValue)
      11. 2.4.11 tHCSResponseCode HCS_setSwitchState (uint8_t swState)
      12. 2.4.12 tHCSResponseCode HCS_updateConfig (TPS2HCS10Q1_CONFIG * config)
      13. 2.4.13 tHCSResponseCode HCS_wakeupDevice (void )
      14. 2.4.14 tHCSResponseCode HCS_writeRegister (uint8_t addr, uint16_t payload)
  6. 3Configuration or Evaluation Tool
  7. 4Code Examples
    1. 4.1 Empty Example
    2. 4.2 I2T Trip Example
    3. 4.3 Low-Power Mode Example
    4. 4.4 Current Sense Example
  8. 5Summary
  9. 6References
  10. 7Revision History

1 Software Ecosystem

The smart fuse ecosystem from Texas Instruments consists of the following software components:

Table 1-1 Smart Fuse Collateral Offering
Collateral Name Description
Smart Fuse Configurator Host GUI tool used to configure TPSxHCxx-Q1 device and export C configuration file for software development. This software is also used to control the HSS-HCSMOTHERBRDEVM and corresponding daughter cards.
Device Specific C Headers Files Header file representation of the HCS device's register map. This file contains all register definitions and enumerations of the device.
HCS Platform Drivers Generic set of drivers with a lower level SPI driver porting layer. Implementation examples are provided for a variety of processors/microcontrollers.
Application Code Examples Common set of code examples that show case some common functionality and differentiation of using the HCS family of high-side switches from Texas Instruments.

A software package containing the HCS Platform Drivers and Application code examples can be found on the corresponding software page. The drivers and code examples are BSD licensed open source allowing for flexible porting/re-use. The software package can be found at HCS-SMARTFUSE-DRIVERS.

Note that the functionality of the Smart Fuse Configurator software with relation to the HSS-HCSMOTHERBRDEVM are detailed in the Smart Fuse Evaluation Module, user's guide.

All pieces of the software collateral are designed to work with each other, simplify software development, and make it as easy as possible to get started with using the HCS family of high-side switches. A standard development flow can include the following steps:

  1. Use the Smart Fuse Configurator to generate the initial configuration. These settings will be loaded to the high-side switch over SPI by the microcontroller during boot-up. The settings include current limit configuration, capacitive charge modes, and any specific I2T turning required based on the specific wire gauge curve.
  2. Once configured, the software exports a generic C files that contain a generic C structure that is used for initial configuration/programming.
  3. A pointer of this configuration structure is passed into the HCS_initializeDevice function (Section 2.4.9 ). The driver then programs all of the relevant registers of the device. This API is typically called once on the microcontroller boot/initialization.

Each one of these steps and individual components are described in the following sections.