xref: /openbmc/linux/include/linux/mfd/max5970.h (revision 49f661ba)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * Device driver for regulators in MAX5970 and MAX5978 IC
4  *
5  * Copyright (c) 2022 9elements GmbH
6  *
7  * Author: Patrick Rudolph <patrick.rudolph@9elements.com>
8  */
9 
10 #ifndef _MFD_MAX5970_H
11 #define _MFD_MAX5970_H
12 
13 #include <linux/regmap.h>
14 
15 #define MAX5970_NUM_SWITCHES 2
16 #define MAX5978_NUM_SWITCHES 1
17 #define MAX5970_NUM_LEDS     4
18 
19 struct max5970_data {
20 	int num_switches;
21 	u32 irng[MAX5970_NUM_SWITCHES];
22 	u32 mon_rng[MAX5970_NUM_SWITCHES];
23 	u32 shunt_micro_ohms[MAX5970_NUM_SWITCHES];
24 };
25 
26 enum max5970_chip_type {
27 	TYPE_MAX5978 = 1,
28 	TYPE_MAX5970,
29 };
30 
31 #define MAX5970_REG_CURRENT_L(ch)		(0x01 + (ch) * 4)
32 #define MAX5970_REG_CURRENT_H(ch)		(0x00 + (ch) * 4)
33 #define MAX5970_REG_VOLTAGE_L(ch)		(0x03 + (ch) * 4)
34 #define MAX5970_REG_VOLTAGE_H(ch)		(0x02 + (ch) * 4)
35 #define MAX5970_REG_MON_RANGE			0x18
36 #define  MAX5970_MON_MASK			0x3
37 #define  MAX5970_MON(reg, ch)			(((reg) >> ((ch) * 2)) & MAX5970_MON_MASK)
38 #define  MAX5970_MON_MAX_RANGE_UV		16000000
39 
40 #define MAX5970_REG_CH_UV_WARN_H(ch)		(0x1A + (ch) * 10)
41 #define MAX5970_REG_CH_UV_WARN_L(ch)		(0x1B + (ch) * 10)
42 #define MAX5970_REG_CH_UV_CRIT_H(ch)		(0x1C + (ch) * 10)
43 #define MAX5970_REG_CH_UV_CRIT_L(ch)		(0x1D + (ch) * 10)
44 #define MAX5970_REG_CH_OV_WARN_H(ch)		(0x1E + (ch) * 10)
45 #define MAX5970_REG_CH_OV_WARN_L(ch)		(0x1F + (ch) * 10)
46 #define MAX5970_REG_CH_OV_CRIT_H(ch)		(0x20 + (ch) * 10)
47 #define MAX5970_REG_CH_OV_CRIT_L(ch)		(0x21 + (ch) * 10)
48 
49 #define  MAX5970_VAL2REG_H(x)		(((x) >> 2) & 0xFF)
50 #define  MAX5970_VAL2REG_L(x)		((x) & 0x3)
51 
52 #define MAX5970_REG_DAC_FAST(ch)	(0x2E + (ch))
53 
54 #define MAX5970_FAST2SLOW_RATIO		200
55 
56 #define MAX5970_REG_STATUS0		0x31
57 #define  MAX5970_CB_IFAULTF(ch)		(1 << (ch))
58 #define  MAX5970_CB_IFAULTS(ch)		(1 << ((ch) + 4))
59 
60 #define MAX5970_REG_STATUS1		0x32
61 #define  STATUS1_PROT_MASK		0x3
62 #define  STATUS1_PROT(reg) \
63 	(((reg) >> 6) & STATUS1_PROT_MASK)
64 #define  STATUS1_PROT_SHUTDOWN		0
65 #define  STATUS1_PROT_CLEAR_PG		1
66 #define  STATUS1_PROT_ALERT_ONLY	2
67 
68 #define MAX5970_REG_STATUS2		0x33
69 #define  MAX5970_IRNG_MASK		0x3
70 #define  MAX5970_IRNG(reg, ch) \
71 	(((reg) >> ((ch) * 2)) & MAX5970_IRNG_MASK)
72 
73 #define MAX5970_REG_STATUS3		0x34
74 #define  MAX5970_STATUS3_ALERT		BIT(4)
75 #define  MAX5970_STATUS3_PG(ch)		BIT(ch)
76 
77 #define MAX5970_REG_FAULT0		0x35
78 #define  UV_STATUS_WARN(ch)		(1 << (ch))
79 #define  UV_STATUS_CRIT(ch)		(1 << ((ch) + 4))
80 
81 #define MAX5970_REG_FAULT1		0x36
82 #define  OV_STATUS_WARN(ch)		(1 << (ch))
83 #define  OV_STATUS_CRIT(ch)		(1 << ((ch) + 4))
84 
85 #define MAX5970_REG_FAULT2		0x37
86 #define  OC_STATUS_WARN(ch)		(1 << (ch))
87 
88 #define MAX5970_REG_CHXEN		0x3b
89 #define  CHXEN(ch)			(3 << ((ch) * 2))
90 
91 #define MAX5970_REG_LED_FLASH		0x43
92 
93 #define MAX_REGISTERS			0x49
94 #define ADC_MASK			0x3FF
95 
96 #endif				/* _MFD_MAX5970_H */
97