SBAS934A June   2020  – December 2021 TMAG5170-Q1

PRODUCTION DATA  

  1. 1 Features
  2. 2 Applications
  3. 3 Description
  4. 4 Revision History
  5. 5 Pin Configuration and Functions
  6. 6 Specifications
    1. 6.1 Absolute Maximum Ratings
    2. 6.2 ESD Ratings
    3. 6.3 Thermal Information
    4. 6.4 Recommended Operating Conditions
    5. 6.5 Electrical Characteristics
    6. 6.6 Magnetic Characteristics
    7. 6.7 Power up Timing
    8. 6.8 SPI Interface Timing
    9. 6.9 Typical Characteristics
  7. 7 Detailed Description
    1. 7.1 Overview
    2. 7.2 Functional Block Diagram
    3. 7.3 Feature Description
      1. 7.3.1 Magnetic Flux Direction
      2. 7.3.2 Sensor Location
      3. 7.3.3 Magnetic Range Selection
      4. 7.3.4 Update Rate Settings
      5. 7.3.5 ALERT Function
        1. 7.3.5.1 Interrupt and Trigger Mode
        2. 7.3.5.2 Magnetic Switch Mode
      6. 7.3.6 Threshold Count
      7. 7.3.7 Diagnostics
        1. 7.3.7.1  Memory CRC Check
        2. 7.3.7.2  ALERT Integrity Check
        3. 7.3.7.3  VCC Check
        4. 7.3.7.4  Internal LDO Under Voltage Check
        5. 7.3.7.5  Digital Core Power-on Reset Check
        6. 7.3.7.6  SDO Output Check
        7. 7.3.7.7  Communication CRC Check
        8. 7.3.7.8  Oscillator Integrity Check
        9. 7.3.7.9  Magnetic Field Threshold Check
        10. 7.3.7.10 Temperature Alert Check
        11. 7.3.7.11 Analog Front-End (AFE) Check
        12. 7.3.7.12 Hall Resistance and Switch Matrix Check
        13. 7.3.7.13 Hall Offset Check
        14. 7.3.7.14 ADC Check
    4. 7.4 Device Functional Modes
      1. 7.4.1 Operating Modes
        1. 7.4.1.1 Active Mode
        2. 7.4.1.2 Standby Mode
        3. 7.4.1.3 Configuration Mode (DEFAULT)
        4. 7.4.1.4 Sleep Mode
        5. 7.4.1.5 Wake-Up and Sleep Mode
        6. 7.4.1.6 Deep-Sleep Mode
    5. 7.5 Programming
      1. 7.5.1 Data Definition
        1. 7.5.1.1 Magnetic Sensor Data
        2. 7.5.1.2 Temperature Sensor Data
        3. 7.5.1.3 Magnetic Sensor Offset Correction
        4. 7.5.1.4 Angle and Magnitude Data Definition
      2. 7.5.2 SPI Interface
        1. 7.5.2.1 SCK
        2. 7.5.2.2 CS
        3. 7.5.2.3 SDI
        4. 7.5.2.4 SDO
          1. 7.5.2.4.1 Regular 32-Bit SDO Read
          2. 7.5.2.4.2 Special 32-Bit SDO Read
        5. 7.5.2.5 SPI CRC
        6. 7.5.2.6 SPI Frame
          1. 7.5.2.6.1 32-Bit Read Frame
          2. 7.5.2.6.2 32-Bit Write Frame
    6. 7.6 Register Map
      1. 7.6.1 TMAG5170 Registers
  8. 8 Application and Implementation
    1. 8.1 Application Information
      1. 8.1.1 Selecting the Sensitivity Option
      2. 8.1.2 Temperature Compensation for Magnets
      3. 8.1.3 Sensor Conversion
        1. 8.1.3.1 Continuous Conversion
        2. 8.1.3.2 Trigger Conversion
        3. 8.1.3.3 Pseudo-Simultaneous Sampling
      4. 8.1.4 Error Calculation During Linear Measurement
      5. 8.1.5 Error Calculation During Angular Measurement
    2. 8.2 Typical Application
      1. 8.2.1 Design Requirements
        1. 8.2.1.1 Gain Adjustment for Angle Measurement
      2. 8.2.2 Detailed Design Procedure
      3. 8.2.3 Application Curves
    3. 8.3 Do's and Don'ts
  9. 9 Power Supply Recommendations
  10. 10Layout
    1. 10.1 Layout Guidelines
    2. 10.2 Layout Example
  11. 11Device and Documentation Support
    1. 11.1 Receiving Notification of Documentation Updates
    2. 11.2 Support Resources
    3. 11.3 Trademarks
    4. 11.4 Electrostatic Discharge Caution
    5. 11.5 Glossary
  12. 12Mechanical, Packaging, and Orderable Information

Package Options

Mechanical Data (Package|Pins)
Thermal pad, mechanical data (Package|Pins)
Orderable Information

7.6.1 TMAG5170 Registers

Table 7-4 lists the TMAG5170 registers. All register offset addresses not listed in Table 7-4 should be considered as reserved locations and the register contents should not be modified.

Reserved 2

Table 7-4 TMAG5170 Registers
Offset Acronym Register Name Section
0h DEVICE_CONFIG Configure Device Operation Modes Go
1h SENSOR_CONFIG Configure Device Operation Modes Go
2h SYSTEM_CONFIG Configure Device Operation Modes Go
3h ALERT_CONFIG Configure Device Operation Modes Go
4h X_THRX_CONFIG Configure Device Operation Modes Go
5h Y_THRX_CONFIG Configure Device Operation Modes Go
6h Z_THRX_CONFIG Configure Device Operation Modes Go
7h T_THRX_CONFIG Configure Device Operation Modes Go
8h CONV_STATUS Conversion Status Register Go
9h X_CH_RESULT Conversion Result Register Go
Ah Y_CH_RESULT Conversion Result Register Go
Bh Z_CH_RESULT Conversion Result Register Go
Ch TEMP_RESULT Conversion Result Register Go
Dh AFE_STATUS Status Register Go
Eh SYS_STATUS Status Register Go
Fh TEST_CONFIG Test Configuration Register Go
10h OSC_MONITOR Conversion Result Register Go
11h MAG_GAIN_CONFIG Configure Device Operation Modes Go
12h MAG_OFFSET_CONFIG Configure Device Operation Modes Go
13h ANGLE_RESULT Conversion Result Register Go
14h MAGNITUDE_RESULT Conversion Result Register Go

Complex bit access types are encoded to fit into small table cells. Table 7-5 shows the codes that are used for access types in this section.

Table 7-5 TMAG5170 Access Type Codes
Access Type Code Description
Read Type
R R Read
RC R
C		 Read
to Clear
Write Type
W W Write
Reset or Default Value
- n Value after reset or the default value

7.6.1.1 DEVICE_CONFIG Register (Offset = 0h) [Reset = 0h]

DEVICE_CONFIG is shown in Table 7-6.

Return to the Summary Table.

Table 7-6 DEVICE_CONFIG Register Field Descriptions
Bit Field Type Reset Description
15 RESERVED R 0h Reserved
14-12 CONV_AVG R/W 0h Enables additional sampling of the sensor data to reduce the noise effect (or to increase resolution)
0h = 1x - 10.0Ksps (3-axes) or 20Ksps (1 axis)
1h = 2x - 5.7Ksps (3-axes) or 13.3Ksps (1 axis)
2h = 4x - 3.1Ksps (3-axes) or 8.0Ksps (1 axis)
3h = 8x - 1.6Ksps (3-axes) or 4.4Ksps (1 axis)
4h = 16x - 0.8Ksps (3-axes) or 2.4Ksps (1 axis)
5h = 32x - 0.4Ksps (3-axes) or 1.2Ksps (1 axis)
6h = Code not used, defaults to 000b if selected
7h = Code not used, defaults to000b if selected
11-10 RESERVED R 0h Reserved
9-8 MAG_TEMPCO R/W 0h Temperature coefficient of sense magnet
0h = 0%/ deg C (Current sensor applications)
1h = 0.12%/deg C (NdBFe)
2h = 0.03% /deg C (SmCo)
3h = 0.2%/deg C (Ceramic)
7 RESERVED R 0h Reserved
6-4 OPERATING_MODE R/W 0h Selects operating mode
0h = Configuration mode, Default (TRIGGER_MODE active)
1h = Stand-by mode (TRIGGER_MODE active)
2h = Active measure mode (Continuous conversion)
3h = Active trigger mode (TRIGGER_MODE active)
4h = Wake-up and sleep mode (duty-cycled mode)
5h = Sleep mode
6h = Deep sleep mode (wakes up at CS signal from controller)
7h = Code not used, defaults to 000b if selected
3 T_CH_EN R/W 0h Enables data acquisition of the temperature channel
0h = Temp channel disabled, Default
1h = Temp channel enabled
2 T_RATE R/W 0h Temperature conversion rate. It is linked to the CONV_AVG field
0h = Same as other sensors per CONV_AVG, Default
1h = Once per conversion set
1 T_HLT_EN R/W 0h Enables temperature limit check
0h = Temperature limit check off, Default
1h = Temperature limit check on
0 RESERVED R 0h Reserved

7.6.1.2 SENSOR_CONFIG Register (Offset = 1h) [Reset = 0h]

SENSOR_CONFIG is shown in Table 7-7.

Return to the Summary Table.

Table 7-7 SENSOR_CONFIG Register Field Descriptions
Bit Field Type Reset Description
15-14 ANGLE_EN R/W 0h Enable angle calculation using two axis data
0h = No angle calculation (default)
1h = X-Y-angle calculation enabled
2h = Y-Z-angle calculation enabled
3h = X-Z-angle calculation enabled
13-10 SLEEPTIME R/W 0h Selects the time spent in low power mode between conversions when OPERATING_MODE =010b
0h = 1ms
1h = 5ms
2h = 10ms
3h = 15ms
4h = 20ms
5h = 30ms
6h = 50ms
7h = 100ms
8h = 500ms
9h = 1000ms
Ah = Code not used, defaults to 0000b if selected
Bh = Code not used, defaults to 0000b if selected
Ch = Code not used, defaults to 0000b if selected
Dh = Code not used, defaults to 0000b if selected
Eh = Code not used, defaults to 0000b if selected
Fh = Code not used, defaults to 0000b if selected
9-6 MAG_CH_EN R/W 0h Enables data acquisition of the magnetic axis channel(s)
0h = All magnetic channels of OFF, DEFAUT
1h = X channel enabled
2h = Y channel enabled
3h = X, Y channel enabled
4h = Z channel enabled
5h = Z, X channel enabled
6h = Y, Z channel enabled
7h = X, Y, Z channel enabled
8h = XYX channel enabled
9h = YXY channel enabled
Ah = YZY channel enabled
Bh = ZYZ channel enabled
Ch = ZXZ channel enabled
Dh = XZX channel enabled
Eh = XYZYX channel enabled
Fh = XYZZYX channel enabled
5-4 Z_RANGE R/W 0h Enables different magnetic ranges to support magnetic fields from ±25mT to ±300mT
0h = ±50mT (TMAG5170A1)/ ±150mT(TMAG5170A2), Default
1h = ±25mT (TMAG5170A1)/ ±75mT(TMAG5170A2)
2h = ±100mT (TMAG5170A1)/ ±300mT(TMAG5170A2)
3h = Code not used, defaults to 00b if selected
3-2 Y_RANGE R/W 0h Enables different magnetic ranges to support magnetic fields from ±25mT to ±300mT
0h = ±50mT (TMAG5170A1)/ ±150mT(TMAG5170A2), Default
1h = ±25mT (TMAG5170A1)/ ±75mT(TMAG5170A2)
2h = ±100mT (TMAG5170A1)/ ±300mT(TMAG5170A2)
3h = Code not used, defaults to 00b if selected
1-0 X_RANGE R/W 0h Enables different magnetic ranges to support magnetic fields from ±25mT to ±300mT
0h = ±50mT (TMAG5170A1)/ ±150mT(TMAG5170A2), Default
1h = ±25mT (TMAG5170A1)/ ±75mT(TMAG5170A2)
2h = ±100mT (TMAG5170A1)/ ±300mT(TMAG5170A2)
3h = Code not used, defaults to 00b if selected

7.6.1.3 SYSTEM_CONFIG Register (Offset = 2h) [Reset = 0h]

SYSTEM_CONFIG is shown in Table 7-8.

Return to the Summary Table.

Table 7-8 SYSTEM_CONFIG Register Field Descriptions
Bit Field Type Reset Description
15-14 RESERVED R 0h Reserved
13-12 DIAG_SEL R/W 0h Selects a diagnostic mode run
0h = Run all data path diagnostics all together, Default
1h = Run only enabled data path diagnostics all together
2h = Run all data path diagnostics in sequence
3h = Run only enabled data path diagnostics in sequence
11 RESERVED R 0h Reserved
10-9 TRIGGER_MODE R/W 0h Selects a condition which initiates a single conversion based off already configured registers. A running conversion completes before executing a trigger. Redundant triggers are ignored. TRIGGER_MODE is available only during the modes explicitly mentioned in OPERATING_MODE.
0h = Conversion start at SPI command, Default
1h = Conversion start at CS pulse
2h = Conversion start at ALERT pulse
3h = Code not used, defaults to 00b if selected
8-6 DATA_TYPE R/W 0h Data Type to be accessed from results registers via SPI
0h = Default 32-bit register access
1h = 12-Bit XY data access
2h = 12-Bit XZ data access
3h = 12-Bit ZY data access
4h = 12-Bit XT data access
5h = 12-Bit YT data access
6h = 12-Bit ZT data access
7h = 12-Bit AM data access
5 DIAG_EN R/W 0h Enables user controlled AFE diagnostic tests
0h = Execution of AFE diagnostics is disabled, Default
1h = Execution of AFE diagnostics is enabled
4-3 RESERVED R 0h Reserved
2 Z_HLT_EN R/W 0h Enables magnetic field limit check on Z axis
0h = Z axis limit check off, Default
1h = Z axis limit check on
1 Y_HLT_EN R/W 0h Enables magnetic field limit check on Y axis
0h = Y axis limit check off, Default
1h = Y axis limit check on
0 X_HLT_EN R/W 0h Enables magnetic field limit check on X axis
0h = X axis limit check off, Default
1h = X axis limit check on

7.6.1.4 ALERT_CONFIG Register (Offset = 3h) [Reset = 0h]

ALERT_CONFIG is shown in Table 7-9.

Return to the Summary Table.

Table 7-9 ALERT_CONFIG Register Field Descriptions
Bit Field Type Reset Description
15-14 RESERVED R 0h Reserved
13 ALERT_LATCH R/W 0h Latched ALERT mode select
0h = ALERT sources are not latched. ALERT is asserted only while the source of the ALERT response is present
1h = ALERT sources are latched. ALERT response is latched when the source of the ALERT is asserted until cleared on Read of the corresponding status register (AFE_STATUS, SYS_STATUS, or result registers)
12 ALERT_MODE R/W 0h ALERT mode select
0h = Interrupt mode
1h = Switch mode. This mode overrides any interrupt function (ALERT trigger is also disabled), and implements Hall switch function based off the *_THRX_ALRT settings. In the switch mode the corresponding X_HLT_EN, Y_HLT_EN, Z_HLT_EN need to be set.
11 STATUS_ALRT R/W 0h Enable ALERT response when any flag in the AFE_STATUS or SYS_STATUS registers are set
0h = ALERT is not asserted when any of the AFE_STATUS or SYS_STATUS bit is set
1h = ALERT output is asserted when any of the AFE_STATUS or SYS_STATUS bit is set
10-9 RESERVED R 0h Reserved
8 RSLT_ALRT R/W 0h Enable ALERT response when the configured set of conversions is complete
0h = ALERT is not used to signal when the configured set of conversions are complete
1h = ALERT output is asserted when the configured set of conversions are complete
7-6 RESERVED R 0h Reserved
5-4 THRX_COUNT R/W 0h Number of conversions above the HIGH threshold or below the LOW threshold before the ALERT response is initiated
0h = 1-Conversion result
1h = 2-Conversion results
2h = 3-Conversion results
3h = 4-Conversion results
3 T_THRX_ALRT R/W 0h Temperature threshold ALERT enable
0h = ALERT is not used to signal when temperature thresholds are crossed
1h = ALERT output is asserted when temperature thresholds are crossed
2 Z_THRX_ALRT R/W 0h Z-Channel threshold ALERT enable
0h = ALERT is not used to signal when Z-Axis magnetic thresholds are crossed
1h = ALERT output is asserted when Z-Axis magnetic thresholds are crossed
1 Y_THRX_ALRT R/W 0h Y-Channel threshold ALERT enable
0h = ALERT is not used to signal when Y-Axis magnetic thresholds are crossed
1h = ALERT output is asserted when Y-Axis magnetic thresholds are crossed
0 X_THRX_ALRT R/W 0h X-Channel threshold ALERT enable
0h = ALERT is not used to signal when X-Axis magnetic thresholds are crossed
1h = ALERT output is asserted when X-Axis magnetic thresholds are crossed

7.6.1.5 X_THRX_CONFIG Register (Offset = 4h) [Reset = 7D83h]

X_THRX_CONFIG is shown in Table 7-10.

Return to the Summary Table.

Table 7-10 X_THRX_CONFIG Register Field Descriptions
Bit Field Type Reset Description
15-8 X_HI_THRESHOLD R/W 7Dh X-Axis maximum magnetic field threshold. User input as 2's complement 8-bit binary number. The threshold in mT can be calculated as: (X_RANGE/128)*X_HI_THRESHOLD. Default to 98% of the full-scale
7-0 X_LO_THRESHOLD R/W 83h X-Axis minimum magnetic field threshold. User input as 2's complement 8-bit binary number. The threshold in mT can be calculated as: (X_RANGE/128)*X_LO_THRESHOLD. Default to -98% of the full-scale

7.6.1.6 Y_THRX_CONFIG Register (Offset = 5h) [Reset = 7D83h]

Y_THRX_CONFIG is shown in Table 7-11.

Return to the Summary Table.

Table 7-11 Y_THRX_CONFIG Register Field Descriptions
Bit Field Type Reset Description
15-8 Y_HI_THRESHOLD R/W 7Dh Y-Axis maximum magnetic field threshold. User input as 2's complement 8-bit binary number. The threshold in mT can be calculated as: (Y_RANGE/128)*Y_HI_THRESHOLD. Default to 98% of the full-scale.
7-0 Y_LO_THRESHOLD R/W 83h Y-Axis minimum magnetic field threshold. User input as 2's complement 8-bit binary number. The threshold in mT can be calculated as: (Y_RANGE/128)*Y_LO_THRESHOLD. Default to -98% of the full-scale.

7.6.1.7 Z_THRX_CONFIG Register (Offset = 6h) [Reset = 7D83h]

Z_THRX_CONFIG is shown in Table 7-12.

Return to the Summary Table.

Table 7-12 Z_THRX_CONFIG Register Field Descriptions
Bit Field Type Reset Description
15-8 Z_HI_THRESHOLD R/W 7Dh Z-Axis maximum magnetic field threshold. User input as 2's complement 8-bit binary number. The threshold in mT can be calculated as:(Z_RANGE/128)*Z_HI_THRESHOLD. Default to 98% of the full-scale
7-0 Z_LO_THRESHOLD R/W 83h Z-Axis minimum magnetic field threshold. User input as 2's complement 8-bit binary number. The threshold in mT can be calculated as: (Z_RANGE/128)*X_LO_THRESHOLD. Default to -98% of the full-scale

7.6.1.8 T_THRX_CONFIG Register (Offset = 7h) [Reset = 6732h]

T_THRX_CONFIG is shown in Table 7-13.

Return to the Summary Table.

Table 7-13 T_THRX_CONFIG Register Field Descriptions
Bit Field Type Reset Description
15-8 T_HI_THRESHOLD R/W 67h Temperature maximum threshold. User input as 2's complement 8-bit binary number. Each LSB in this field corresponds to 4.267°C. Default value of 67h represents 172°C.
7-0 T_LO_THRESHOLD R/W 32h Temperature minimum threshold. User input as 2's complement 8-bit binary number. Each LSB in this field corresponds to 4.267°C. Default value of 32h represents -53°C.

7.6.1.9 CONV_STATUS Register (Offset = 8h) [Reset = 0h]

CONV_STATUS is shown in Table 7-14.

Return to the Summary Table.

Table 7-14 CONV_STATUS Register Field Descriptions
Bit Field Type Reset Description
15-14 RESERVED R 0h Reserved
13 RDY R 0h Conversion data buffer is ready.
0h = Conversion data not valid (result registers hold previous conversion value)
1h = Conversion data valid
12 A R 0h Angle/Magnitude data from current conversion
0h = Data is not current
1h = Data is current
11 T R 0h Temperature data from current conversion
0h = Temperature data is not current
1h = Temperature data is current
10 Z R 0h Z-Channel data from current conversion
0h = Z-Channel data is not current
1h = Z-Channel data is current
9 Y R 0h Y-Channel data from current conversion
0h = Y-Channel data is not current
1h = Y-Channel data is current
8 X R 0h X-Channel data from current conversion
0h = X-Channel data is not current
1h = X-Channel data is current
7 RESERVED R 0h Reserved
6-4 SET_COUNT R 0h Rolling count of conversion data sets
3-2 RESERVED R 0h Reserved
1-0 ALRT_STATUS R 0h State of ALERT response
0h = No ALERT conditions
1h = AFE status flag set
2h = SYS status flag set
3h = Flags set in both AFE and SYS status registers

7.6.1.10 X_CH_RESULT Register (Offset = 9h) [Reset = 0h]

X_CH_RESULT is shown in Table 7-15.

Return to the Summary Table.

Table 7-15 X_CH_RESULT Register Field Descriptions
Bit Field Type Reset Description
15-0 X_CH_RESULT R 0h X-Channel data conversion results

7.6.1.11 Y_CH_RESULT Register (Offset = Ah) [Reset = 0h]

Y_CH_RESULT is shown in Table 7-16.

Return to the Summary Table.

Table 7-16 Y_CH_RESULT Register Field Descriptions
Bit Field Type Reset Description
15-0 Y_CH_RESULT R 0h Y-Channel data conversion results

7.6.1.12 Z_CH_RESULT Register (Offset = Bh) [Reset = 0h]

Z_CH_RESULT is shown in Table 7-17.

Return to the Summary Table.

Table 7-17 Z_CH_RESULT Register Field Descriptions
Bit Field Type Reset Description
15-0 Z_CH_RESULT R 0h Z-Channel data conversion results

7.6.1.13 TEMP_RESULT Register (Offset = Ch) [Reset = 0h]

TEMP_RESULT is shown in Table 7-18.

Return to the Summary Table.

Table 7-18 TEMP_RESULT Register Field Descriptions
Bit Field Type Reset Description
15-0 TEMP_RESULT R 0h Temperature sensor data conversion results

7.6.1.14 AFE_STATUS Register (Offset = Dh) [Reset = 8000h]

AFE_STATUS is shown in Table 7-19.

Return to the Summary Table.

Table 7-19 AFE_STATUS Register Field Descriptions
Bit Field Type Reset Description
15 CFG_RESET RC 1h Device power up status. This bit is reset when microcontroller reads the AFE_STATUS register.
0h = Device reset has been acknowledged and cleared
1h = Device has experienced a hardware reset after a power down or brown-out
14-13 RESERVED R 0h Reserved
12 SENS_STAT RC 0h Analog front end sensor diagnostic status
0h = No error detected
1h = Analog front end sensor diagnostic test failed
11 TEMP_STAT RC 0h Temperature sensor diagnostic status
0h = No error detected
1h = Analog front end temperature sensor diagnostic test failed
10 ZHS_STAT RC 0h Z-Axis hall sensor diagnostic status
0h = No error detected
1h = Z-Axis hall sensor diagnostic test failed
9 YHS_STAT RC 0h Y-Axis hall sensor diagnostic status
0h = No error detected
1h = Y-Axis hall sensor diagnostic test failed
8 XHS_STAT RC 0h X-Axis hall sensor diagnostic status
0h = No error detected
1h = X-Axis hall sensor diagnostic test failed
7-2 RESERVED R 0h Reserved
1 TRIM_STAT RC 0h Trim data error
0h = No trim data errors were detected
1h = Trim data error was detected
0 LDO_STAT RC 0h LDO error
0h = No faults in the internal LDO supplied power were detected
1h = A fault in the internal LDO supplied power was detected

7.6.1.15 SYS_STATUS Register (Offset = Eh) [Reset = 0h]

SYS_STATUS is shown in Table 7-20.

Return to the Summary Table.

Table 7-20 SYS_STATUS Register Field Descriptions
Bit Field Type Reset Description
15 ALRT_LVL R 0h Reflects the current state of the ALERT pin feed-back path
0h = The input ALERT logic level is low
1h = The input ALERT logic level is high
14 ALRT_DRV RC 0h Each time the open drain ALERT signal is driven, the feedback circuit checks if the ALERT output goes Low. An error flag is generated at the ALRT_DRV bit if the output doesn't go Low.
0h = No ALERT drive error detected
1h = ALERT drive error detected
13 SDO_DRV RC 0h The Logic value driven output on SDO was not the value of the SDO Pin Feed-back path when SDO is being driven by the device
0h = No SDO drive error detected
1h = SDO drive error detected
12 CRC_STAT RC 0h Cyclic redundancy check error
0h = No cyclic redundancy check error was detected
1h = Cyclic redundancy check error was detected for a SPI transaction
11 FRAME_STAT RC 0h Incorrect number of clocks in SPI frame
0h = No frame error was detected
1h = Incorrect number of clocks detected for a SPI transaction
10-8 OPERATING_STAT R 0h Reports the status of operating mode
0h = Config state
1h = Standby state
2h = Active measure (Continuous Mode) state
3h = Active triggered mode state
4h = DCM active state
5h = DCM Sleep state
6h = Sleep state
7-6 RESERVED R 0h Reserved
5 VCC_OV RC 0h VCC over-voltage detection in active or stand-by mode
0h = No over-voltage detected on VCC
1h = VCC was detected to be over-voltage
4 VCC_UV RC 0h VCC under voltage detection in active or stand-by mode
0h = No under-voltage was detected on VCC
1h = VCC was detected to be under-voltage
3 TEMP_THX RC 0h Temperature threshold crossing detected
0h = No temperature threshold crossing detected
1h = Temperature threshold crossing detected
2 ZCH_THX RC 0h Z-Channel threshold crossing detected
0h = No Z-Axis magnetic field threshold crossing detected
1h = Z-Axis magnetic field threshold crossing detected
1 YCH_THX RC 0h Y-Channel threshold crossing detected
0h = No Y-Axis magnetic field threshold crossing detected
1h = Y-Axis magnetic field threshold crossing detected
0 XCH_THX RC 0h X-Channel threshold crossing detected
0h = No X-Axis magnetic field threshold crossing detected
1h = X-Axis magnetic field threshold crossing detected

7.6.1.16 TEST_CONFIG Register (Offset = Fh) [Reset = X]

TEST_CONFIG is shown in Table 7-21.

Return to the Summary Table.

Table 7-21 TEST_CONFIG Register Field Descriptions
Bit Field Type Reset Description
15-6 RESERVED R 1h Reserved
5-4 VER R X Indicates the version of the device
0h = A1 rev
1h = A2 rev
2h = reserved
3h = reserved
3 RESERVED R 0h Reserved
2 CRC_DIS R/W 0h Enable or disable CRC in SPI communication
0h = CRC enabled in SPI communication (Default)
1h = CRC disabled in SPI communication
1-0 OSC_CNT_CTL R/W 0h Oscillator count control - starts, stops, and resets the counter driven by the HFOSC or LFOSC oscillator to facilitate oscillator frequency and integrity checks
0h = Reset OSC counter (default)
1h = Start OSC counter driven by HFOSC
2h = Start OSC counter driven by LFOSC
3h = Stop OSC counter

7.6.1.17 OSC_MONITOR Register (Offset = 10h) [Reset = 0h]

OSC_MONITOR is shown in Table 7-22.

Return to the Summary Table.

Table 7-22 OSC_MONITOR Register Field Descriptions
Bit Field Type Reset Description
15-0 OSC_COUNT R 0h Oscillator Counter. The number of selected oscillator clock cycles that have been counted since Oscillator Counter was started. The HFOSC and LFOSC clock roll-over the 16-bit counter once reaching the max value.

7.6.1.18 MAG_GAIN_CONFIG Register (Offset = 11h) [Reset = 0h]

MAG_GAIN_CONFIG is shown in Table 7-23.

Return to the Summary Table.

Table 7-23 MAG_GAIN_CONFIG Register Field Descriptions
Bit Field Type Reset Description
15-14 GAIN_SELECTION R/W 0h Enables the selection of a particular Hall axis for amplitude correction to get accurate angle measurement
0h = No axis is selected (Default)
1h = X-axis is selected
2h = Y-axis is selected
3h = Z-axis is selected
13-11 RESERVED R 0h Reserved
10-0 GAIN_VALUE R/W 0h 11-bit gain value determined by controller to adjust the a particular Hall axis value. The gain value is anywhere between 0 and 2. Gain is calculated as 'user entered value/1024'.

7.6.1.19 MAG_OFFSET_CONFIG Register (Offset = 12h) [Reset = 0h]

MAG_OFFSET_CONFIG is shown in Table 7-24.

Return to the Summary Table.

Table 7-24 MAG_OFFSET_CONFIG Register Field Descriptions
Bit Field Type Reset Description
15-14 OFFSET_SELECTION R/W 0h Enables the selection of a particular Hall axis for offset correction to get accurate angle measurement:
00b = No axis is selected for offset correction (Default).
01b = Only OFFSET_VALUE1 is used for offset correction. Applied to X axis when ANGLE_EN = 01b or 11b, and to Y axis when ANGLE_EN =10b. No axis is selected if ANGLE_EN =00b.
10b = Only OFFSET_VALUE2 is used for offset correction. Applied to Y axis when ANGLE_EN = 01b, and to Z axis when ANGLE_EN =10b or 11b. No axis is selected if ANGLE_EN =00b.
11b = Both OFFSET_VALUE1 and OFFSET_VALUE2 are used for offset correction. OFFSET_VALUE1 applied to X axis when ANGLE_EN = 01b or 11b, and to Y axis when ANGLE_EN =10b. OFFSET_VALUE2 applied to Y axis when ANGLE_EN = 01b, and to Z axis when ANGLE_EN =10b or 11b. No axis is selected if ANGLE_EN =00b.
13-7 OFFSET_VALUE1 R/W 0h 7-bit, 2' complement offset value determined by controller to adjust a particular Hall axis value. The range of possible offset valid entries can be +/-64. The offset value is calculated from the user input as the 7 LSB bits of a 11-bit range per SENSOR_CONFIG register setting for the corresponding axis. Default offset value is 0.
6-0 OFFSET_VALUE2 R/W 0h 7-bit, 2' complement offset value determined by controller to adjust a particular Hall axis value. The range of possible offset valid entries can be +/-64. The offset value is calculated from the user input as the 7 LSB bits of a 11-bit range per SENSOR_CONFIG register setting for the corresponding axis. Default offset value is 0.

7.6.1.20 ANGLE_RESULT Register (Offset = 13h) [Reset = 0h]

ANGLE_RESULT is shown in Table 7-25.

Return to the Summary Table.

Table 7-25 ANGLE_RESULT Register Field Descriptions
Bit Field Type Reset Description
15-0 ANGLE_RESULT R 0h Angle measurement result in degree. The data is displayed from 0 to 360 degree in 13 LSB bits. The 4 LSB bits allocated for fraction of an angle in the format (xxxx/16).

7.6.1.21 MAGNITUDE_RESULT Register (Offset = 14h) [Reset = 0h]

MAGNITUDE_RESULT is shown in Table 7-26.

Return to the Summary Table.

Table 7-26 MAGNITUDE_RESULT Register Field Descriptions
Bit Field Type Reset Description
15-0 MAGNITUDE_RESULT R 0h Resultant vector magnitude (during angle measurement) result. This value should be constant during 360 degree measurements