MAX15301 PMBus Command Set User’s Guide Rev 1; 10/14 Maxim Integrated cannot assume responsibility for use of any circuitry other than circuitry entirely embodied in a Maxim Integrated product. No circuit patent licenses are implied. Maxim Integrated reserves the right to change the circuitry and specifications without notice at any time. Maxim Integrated 160 Rio Robles, San Jose, CA 95134 USA 1-408-601-1000 © 2014 Maxim Integrated Products, Inc.
MAX15301 PMBus Command Set User’s Guide Introduction Maxim Integrated InTune™ digital power products utilize the PMBus™ command standard for configuration, control and telemetry. This document lists and describes the PMBus commands implemented in the MAX15301 digital DC-DC controller. Standard commands from the PMBus specification are not described in detail unless there are deviations from the PMBus specification functionality. Maxim manufacturer-specific commands are fully described in this document.
MAX15301 PMBus Command Set User’s Guide Table of Contents Introduction ................................................................................................................................................................................. 1 Part Number Differences ............................................................................................................................................................. 2 MAX15301AA01 ...............................................................
MAX15301 PMBus Command Set User’s Guide VOUT_UV_FAULT_LIMIT ........................................................................................................................................................ 21 VOUT_UV_FAULT_RESPONSE ................................................................................................................................................ 22 IOUT_OC_FAULT_LIMIT .........................................................................................................
MAX15301 PMBus Command Set User’s Guide CAPABILITY ............................................................................................................................................................................. 36 PMBUS_REVISION .................................................................................................................................................................. 36 MFR_ID ................................................................................................
MAX15301 PMBus Command Set User’s Guide Trademarks ................................................................................................................................................................................ 53 Revision History .........................................................................................................................................................................
MAX15301 PMBus Command Set User’s Guide On, Off, and Margin Testing Related Commands OPERATION Reference: Command Code: Data Bytes: Transfer: Standard Command 0x01 1 Read/Write Byte Lockable: Format: Units: Factory Value: Description/Notes: See Section 12.1 of the PMBus Specification Part II.
MAX15301 PMBus Command Set User’s Guide ON_OFF_CONFIG Reference: Command Code: Data Bytes: Transfer: Standard Command 0x02 1 Read/Write Byte Lockable: Format: Units: Factory Value: Description/Notes: See Section 12.2 of the PMBus Specification Part II.
MAX15301 PMBus Command Set User’s Guide VIN_OFF Reference: Command Code: Data Bytes: Transfer: Standard Command 0x36 2 Read/Write Word Lockable: Format: Units: Factory Value: Description/Notes: See Section 14.6 of the PMBus Specification Part II. Yes Linear V 0xCAC0 (5.5V) The MAX15301 hardware has 8-bit resolution for the minimum input voltage required for regulation, to a maximum value of ≈14.75V.
MAX15301 PMBus Command Set User’s Guide Output Voltage Related Commands VOUT_MODE Reference: Command Code: Data Bytes: Transfer: Standard Command 0x20 1 Read Byte Lockable: Format: Units: Factory Value: Description/Notes: See Section 8.2 of the PMBus Specification Part II. No Mixed: bit-field and 2’s complement N/A 0x14 (Linear Mode, exponent -12) The MAX15301 only supports Linear Mode values for output voltage related commands. The VOUT_MODE command is read-only and the value cannot be changed.
MAX15301 PMBus Command Set User’s Guide VOUT_TRIM VOUT_CAL_OFFSET, and the result is sent to the control loop as the output voltage setpoint. The value of VOUT_TRIM is not subtracted from READ_VOUT, so nonzero VOUT_TRIM values will result in a difference between VOUT_COMMAND and READ_VOUT.
MAX15301 PMBus Command Set User’s Guide VOUT_MARGIN_HIGH Description/Notes: See Section 13.6 of the PMBus Specification Part II. VOUT_MARGIN_HIGH mantissa data sent to and from the MAX15301 must be divided by 4096 to determine the actual voltage value, according to the fixed value of VOUT_MODE. The factory value of 0x0001 (0.244mV) will be overridden during initialization VOUT_COMMAND x 1.05, unless a specific value has been written to the User Store.
MAX15301 PMBus Command Set User’s Guide VOUT_TRANSITION_RATE Reference: Command Code: Data Bytes: Transfer: Standard Command 0x27 2 Read/Write Word Lockable: Format: Units: Factory Value: Description/Notes: See Section 13.8 of the PMBus Specification Part II. Yes Linear mV/μs (or V/ms, kV/s) 0x9B33 (0.1V/ms, see Description) To achieve output voltage slew-rate control, the MAX15301 has an 8-bit timer with approximately 243ns resolution.
MAX15301 PMBus Command Set User’s Guide VOUT_DROOP accurate adaptive voltage positioning results with the VOUT_DROOP command. Note that VOUT_DROOP can accept negative resistance values, allowing a user to compensation for resistive losses between the output voltage remote sense point and the load, if desired. (Setting VOUT_DROOP to a negative value will case output voltage to rise with increasing load.
MAX15301 PMBus Command Set User’s Guide Switching Frequency and PWM Commands FREQUENCY_SWITCH Reference: Command Code: Data Bytes: Transfer: Standard Command 0x33 2 Read/Write Word Lockable: Format: Units: Factory Value: Description/Notes: See Section 14.4 of the PMBus Specification Part II.
MAX15301 PMBus Command Set User’s Guide INTERLEAVE ADDR1 pins, unless a non-zero value of INTERLEAVE has been written to the User Store. The value of the ADDR0 and ADDR1 pin resistance is measured only once during initialization (power-up). Because the MAX15301 uses one of two different PWM “speed modes” depending on the switching frequency selected (see FREQUENCY_SWITCH), the INTERLEAVE command will show unexpected results if switching frequency crosses the 475kHz speed-mode boundary after initialization.
MAX15301 PMBus Command Set User’s Guide POWER_GOOD_OFF Reference: Command Code: Data Bytes: Transfer: Standard Command 0x5F 2 Read/Write Word Lockable: Format: Units: Factory Value: Description/Notes: See Section 15.32.2 of the PMBus Specification Part II. Yes Unsigned integer mantissa V 0x0F99 (see Description) POWER_GOOD_OFF mantissa data sent to and from the MAX15301 must be divided by 4096 to determine the actual voltage value, according to the fixed value of VOUT_MODE.
MAX15301 PMBus Command Set User’s Guide TON_RISE Reference: Command Code: Data Bytes: Transfer: Standard Command 0x61 2 Read/Write Word Lockable: Format: Units: Factory Value: Description/Notes: See Section 16.2 of the PMBus Specification Part II. Yes Linear ms 0xCA80 (see Description) The TON_RISE command sets the ramp-up time from 0V to regulation at VOUT_COMMAND. The nominal factory value is 5ms.
MAX15301 PMBus Command Set User’s Guide TOFF_FALL Reference: Command Code: Data Bytes: Transfer: Standard Command 0x65 2 Read/Write Word Lockable: Format: Units: Factory Value: Description/Notes: See Section 16.6 of the PMBus Specification Part II. Yes Linear ms 0xCA80 (see Description) The TOFF_FALL command sets the ramp-down time from regulation at VOUT_COMMAND to 0V. The nominal factory value is 5ms.
MAX15301 PMBus Command Set User’s Guide Fault Related Commands CLEAR_FAULTS Reference: Command Code: Data Bytes: Transfer: Standard Command 0x03 0 Send Byte Lockable: Format: Units: Factory Value: Description/Notes: See Section 15.1 of the PMBus Specification Part II. Yes N/A N/A N/A If the MAX15301 has latched off for a fault condition, sending the CLEAR_FAULTS command will cause a restart.
MAX15301 PMBus Command Set User’s Guide VOUT_OV_FAULT_RESPONSE Reference: Command Code: Data Bytes: Transfer: Standard Command 0x41 1 Read/Write Byte Lockable: Format: Units: Factory Value: Yes Bit field N/A 0x80 (Stop regulating and remain off) Description/Notes: See Sections 10.5.1 and 15.3 of the PMBus Specification Part II. Note that the MAX15301 does not support finite, non-zero restart-attempt counts. (Continuous restart attempts are supported.
MAX15301 PMBus Command Set User’s Guide VOUT_UV_FAULT_LIMIT VOUT_COMMAND x 0.85, unless a specific value has been written to the User Store. VOUT_UV_FAULT_RESPONSE Reference: Command Code: Data Bytes: Transfer: Standard Command 0x45 1 Read/Write Byte Lockable: Format: Units: Factory Value: Description/Notes: See Sections 10.5.1 and 15.7 of the PMBus Specification Part II.
MAX15301 PMBus Command Set User’s Guide IOUT_OC_FAULT_RESPONSE Reference: Command Code: Data Bytes: Transfer: Standard Command 0x47 1 Read/Write Byte Lockable: Format: Units: Factory Value: Description/Notes: See Sections 10.5.1 and 15.9 of the PMBus Specification Part II. Yes Bit field N/A 0xBF (Shut down, retry every 700ms) For overcurrent faults, the MAX15301 implements the fault responses of PMBus Specification section 10.5.1, rather than the responses of section 10.5.2.
MAX15301 PMBus Command Set User’s Guide OT_FAULT_LIMIT temperature signal instead. In addition to the PMBus-programmable OT_FAULT_LIMIT value, there is also a hard-coded limit of 130°C that applies solely to the internal temperature signal to protect the flash memory of the MAX15301. Overtemperature fault hysteresis is achieved in the MAX15301 by using the OT_WARN_LIMIT as the “fault cleared” threshold for OT_FAULT_LIMIT. For this reason, it is important to always set OT_WARN_LIMIT below OT_FAULT_LIMIT.
MAX15301 PMBus Command Set User’s Guide OT_WARN_LIMIT Reference: Command Code: Data Bytes: Transfer: Standard Command 0x51 2 Read/Write Word Lockable: Format: Units: Factory Value: Description/Notes: See Section 15.19 of the PMBus Specification Part II. Yes Linear °C 0xEAF8 (95°C) The MAX15301 has an internal temperature signal and can also measure temperature at an external location, using a diode junction.
MAX15301 PMBus Command Set User’s Guide VIN_OV_FAULT_RESPONSE 10 11 Stop regulating immediately, delay for the time specified in bits [2:0], then attempt to restart according to bits [5:3]. Stop regulating immediately, and then restart as soon as possible after the fault condition abates. (Default setting) Bits [5:3] determine the number of retry attempts.
MAX15301 PMBus Command Set User’s Guide VIN_UV_FAULT_RESPONSE 11 restart according to bits [5:3]. Stop regulating immediately, and then restart as soon as possible after the fault condition abates. (Default setting) Bits [5:3] determine the number of retry attempts. The MAX15301 supports only a subset of the full PMBus functionality for this portion of the command: 000-110 111 No attempt is made to restart after a fault shutdown.
MAX15301 PMBus Command Set User’s Guide Unit Status Commands STATUS_BYTE Reference: Command Code: Data Bytes: Transfer: Standard Command 0x78 1 Read Byte Lockable: Format: Units: Factory Value: Description/Notes: See Section 17.1 of the PMBus Specification Part II. N/A Bit field N/A N/A STATUS_WORD Reference: Command Code: Data Bytes: Transfer: Standard Command 0x79 2 Read Word Lockable: Format: Units: Factory Value: Description/Notes: See Section 17.2 of the PMBus Specification Part II.
MAX15301 PMBus Command Set User’s Guide STATUS_INPUT Reference: Command Code: Data Bytes: Transfer: Standard Command 0x7C 1 Read Byte Lockable: Format: Units: Factory Value: Description/Notes: See Section 17.5 of the PMBus Specification Part II. N/A Bit field N/A N/A Bits #6, #5, #2, #1, and #0 are not implemented in the MAX15301 because the corresponding fault commands are not supported.
MAX15301 PMBus Command Set User’s Guide Telemetry Commands READ_VIN Reference: Command Code: Data Bytes: Transfer: Standard Command 0x88 2 Read Word Lockable: Format: Units: Factory Value: Description/Notes: See Section 18.1 of the PMBus Specification Part II. N/A Linear V N/A The MAX15301 has 12-bit measurement resolution for input voltage to a maximum value of about 14.75V.
MAX15301 PMBus Command Set User’s Guide READ_TEMPERATURE_1 Reference: Command Code: Data Bytes: Transfer: Standard Command 0x8D 2 Read Word Lockable: Format: Units: Factory Value: Description/Notes: See Section 18.6 of the PMBus Specification Part II. N/A Linear °C N/A The MAX15301 uses READ_TEMPERATURE_1 to report its internal (i.e. die) temperature.
MAX15301 PMBus Command Set User’s Guide READ_FREQUENCY Reference: Command Code: Data Bytes: Transfer: Standard Command 0x95 2 Read Word Lockable: Format: Units: Factory Value: Description/Notes: See Section 18.10 of the PMBus Specification Part II. N/A Linear kHz N/A The READ_FREQUENCY command returns the actual switching frequency in kilohertz. The desired switching frequency is set using the FREQUENCY_SWITCH command.
MAX15301 PMBus Command Set User’s Guide PMB_VALUES
MAX15301 PMBus Command Set User’s Guide Calibration Commands IOUT_CAL_GAIN Reference: Command Code: Data Bytes: Transfer: Standard Command 0x38 2 Read/Write Word Lockable: Format: Units: Factory Value: Description/Notes: See Section 14.8 of the PMBus Specification Part II.
MAX15301 PMBus Command Set User’s Guide EXT_TEMP_CAL (MAX15301AA01) Byte # 0 1 Data Byte Name Ideality Factor and Gain Correction Offset correction Units None °K Description Combined diode ideality factor and external temperature gain correction scalar External temperature measurement offset correction The corrections are applied internal to the MAX15301 as follows: READ_TEMPERATURE_2 = (Measured external temperature) / EXT_TEMP_CAL[0] + EXT_TEMP_CAL[1] - 273.
MAX15301 PMBus Command Set User’s Guide Device Identification Commands CAPABILITY Reference: Command Code: Data Bytes: Transfer: Standard Command 0x19 1 Read Byte Lockable: Format: Units: Factory Value: Description/Notes: See Section 11.12 of the PMBus Specification Part II. N/A Bit field N/A 0xA0 PMBUS_REVISION Reference: Command Code: Data Bytes: Transfer: Standard Command 0x98 1 Read Byte Lockable: Format: Units: Factory Value: Description/Notes: See Section 22.
MAX15301 PMBus Command Set User’s Guide MFR_MODEL Reference: Command Code: Data Bytes: Transfer: Standard Command 0x9A 13 Read/Write Block Lockable: Format: Units: Factory Value: Description/Notes: See Section 22.2.2 of the PMBus Specification Part II. Yes ASCII string N/A Null string Note that the MAX15301 implements MFR_MODEL as a fixed-width string, not as part of a shared memory space.
MAX15301 PMBus Command Set User’s Guide MFR_SERIAL Reference: Command Code: Data Bytes: Transfer: Standard Command 0x9E 13 Read/Write Block Lockable: Format: Units: Factory Value: Description/Notes: See Section 22.2.6 of the PMBus Specification Part II. Yes ASCII string N/A Null string Note that the MAX15301 implements MFR_SERIAL as a fixed-width string, not as part of a shared memory space.
MAX15301 PMBus Command Set User’s Guide Security Commands WRITE_PROTECT Reference: Command Code: Data Bytes: Transfer: Standard Command 0x10 1 Read/Write Byte Lockable: Format: Units: Factory Value: Description/Notes: See Section 11.1 of the PMBus Specification Part II.
MAX15301 PMBus Command Set User’s Guide MANUF_LOCK Reference: Command Code: Data Bytes: Transfer: Maxim Specific 0xE1 2 Write Word Lockable: Format: Units: Factory Value: Yes Direct N/A 0x0000 Description/Notes: The MANUF_LOCK command contains the password value for the “manufacturer” PMBus command security level.
MAX15301 PMBus Command Set User’s Guide USER_CONF memory value of USER_LOCK, then the MAX15301 will ignore attempts to write data to that command. Note that setting a bit for a read-only PMBus command or send-byte PMBus command has no effect, regardless of SECURITY_LEVEL. Likewise, read operations for any PMBus command are never blocked on the basis of USER_CONF and SECURITY_LEVEL. The 32 data bytes for USER_CONF are saved in flash memory as a unique, single instance (i.e.
MAX15301 PMBus Command Set User’s Guide SECURITY_LEVEL Reference: Command Code: Data Bytes: Transfer: Maxim Specific 0xE6 1 Read Byte Description/Notes: The MAX15301 provides two levels of password protection for all writeable PMBus commands, on a per-command basis.
MAX15301 PMBus Command Set User’s Guide Memory and Storage Commands STORE_DEFAULT_ALL Reference: Command Code: Data Bytes: Transfer: Standard Command 0x11 0 Send Byte Lockable: Format: Units: Factory Value: Description/Notes: See Section 11.2 of the PMBus Specification Part II. Yes N/A N/A N/A The MAX15301 includes three banks of nonvolatile (flash memory) storage for most “writeable” PMBus command values, referred to as the USER, DEFAULT, and MAXIM stores.
MAX15301 PMBus Command Set User’s Guide STORE_DEFAULT_ALL NLSS_DATA This command is stored in volatile memory only. Wait at least 450ms for execution after sending the STORE_DEFAULT_ALL command before sending additional PMBus commands. RESTORE_DEFAULT_ALL Reference: Command Code: Data Bytes: Transfer: Standard Command 0x12 0 Send Byte Lockable: Format: Units: Factory Value: Description/Notes: See Section 11.3 of the PMBus Specification Part II.
MAX15301 PMBus Command Set User’s Guide STORE_USER_ALL the RESTORE_USER_ALL command. In general, when the STORE_USER_ALL command is sent, the existing contents of the USER store are erased, and the contents of the working PMBus memory (volatile RAM) are written into the USER store. There are exceptions to this behavior, as follows: OPERATION The OPERATION command is not stored to prevent unintentional enabling/disabling of the output.
MAX15301 PMBus Command Set User’s Guide RESTORE_USER_ALL Reference: Command Code: Data Bytes: Transfer: Standard Command 0x16 0 Send Byte Lockable: Format: Units: Factory Value: Description/Notes: See Section 11.7 of the PMBus Specification Part II. Yes N/A N/A N/A The MAX15301 includes three banks of nonvolatile (flash memory) storage for most “writeable” PMBus command values, referred to as the USER, DEFAULT, and MAXIM stores. These stores are fully independent, but identical in structure.
MAX15301 PMBus Command Set User’s Guide STRAP_DISABLE Reference: Command Code: Data Bytes: Transfer: Maxim Specific 0xDC 2 Read/Write Word Lockable: Format: Units: Factory Value: Yes Bit field N/A 0x0000 Description/Notes: Several commands in the MAX15301 can be set directly by resistor value connected to a device pin, or are set indirectly according to the value of other pin-configurable commands.
MAX15301 PMBus Command Set User’s Guide Control Loop Commands ADAPTIVE_MODE Reference: Command Code: Data Bytes: Transfer: Maxim Specific 0xD0 2 Read/Write Word Description/Notes: The ADAPTIVE_MODE command configures the automatic tuning features of the MAX15301.
MAX15301 PMBus Command Set User’s Guide FEEDBACK_EFFORT Reference: Command Code: Data Bytes: Transfer: Maxim Specific 0xD3 2 Read Byte Lockable: Format: Units: Factory Value: Yes Linear Scalar 0xB200 (0.5) Description/Notes: This command allows some user adjustment of the tradeoff between transient response, load regulation, and output noise. The default value is 0.5, which provides a good balance of transient response performance and output noise characteristics.
MAX15301 PMBus Command Set User’s Guide COMP_MODEL Reference: Command Code: Data Bytes: Transfer: Maxim Specific 0xDB 6 (see Description) Read/Write Block Lockable: Format: Units: Factory Value: Description/Notes: The COMP_MODEL command provides access to key control loop tuning parameters. The three arguments are as follows: Data Byte Number Data Byte Name Units 0 FLC/FSW None 1 FZ/FSW None 2 ZLC None Yes Linear Scalar 0.03167, 0.5, 0.
MAX15301 PMBus Command Set User’s Guide DEADTIME_GCTRL 6 7 TDF (LSB) TDF (MSB) 8 LXDAC 9 GCTRL[0] 10 GCTRL[1] 11 GCTRL[2] 12 GCTRL[3] 13 GCTRL[4] 14 GCTRL[5] 15 GCTRL[6] 16 GCTRL[7] 17 18 GCTRLDAC (LSB) GCTRLDAC (MSB) Signed Integer Unsigned Byte Unsigned Byte Unsigned Byte Unsigned Byte Unsigned Byte Unsigned Byte Unsigned Byte Unsigned Byte Unsigned Byte Unsigned Integer AGD system falling edge deadtime target value AGD system body-diode conduction comparator threshold DAC setting V
MAX15301 PMBus Command Set User’s Guide DEADTIME_GCTRL 255 -1200 Note: the default setting is LXDAC = 15 and this value should not be changed. Variable Gate-Drive Voltage The MAX15301 allows adjustment of the gate drive voltage from approximately 5.2V to 8.7V, as controlled by a 4-bit DAC. The DAC value to gate-drive voltage relationship is as follows: GCTRLDAC Setting 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 Typical Gate Drive (V) 5.2 5.4 5.7 5.9 6.1 6.4 6.6 6.8 7.1 7.3 7.5 7.8 8 8.2 8.5 8.
MAX15301 PMBus Command Set User’s Guide ZETA_P Wait at least 500μs for execution after sending the ZETA_P command before sending additional PMBus commands. Trademarks InTune is a trademark of Maxim Integrated Products, Inc. PMBus is a trademark of SMIF, Inc. Revision History REVISION NUMBER 0 REVISION DATE 11/13 1 10/14 Rev 1 DESCRIPTION Initial release Added information for new MAX15301AA02 part number Default value of VOUT_MAX corrected: VOUT_COMMAND x 1.
