1 // SPDX-License-Identifier: GPL-2.0
3 * Intel MAX 10 Board Management Controller chip
5 * Copyright (C) 2018-2020 Intel Corporation. All rights reserved.
7 #include <linux/bitfield.h>
8 #include <linux/init.h>
9 #include <linux/mfd/core.h>
10 #include <linux/mfd/intel-m10-bmc.h>
11 #include <linux/module.h>
12 #include <linux/mutex.h>
13 #include <linux/regmap.h>
14 #include <linux/spi/spi.h>
21 static struct mfd_cell m10bmc_d5005_subdevs[] = {
22 { .name = "d5005bmc-hwmon" },
25 static struct mfd_cell m10bmc_pacn3000_subdevs[] = {
26 { .name = "n3000bmc-hwmon" },
27 { .name = "n3000bmc-retimer" },
28 { .name = "n3000bmc-secure" },
31 static const struct regmap_range m10bmc_regmap_range[] = {
32 regmap_reg_range(M10BMC_LEGACY_BUILD_VER, M10BMC_LEGACY_BUILD_VER),
33 regmap_reg_range(M10BMC_SYS_BASE, M10BMC_SYS_END),
34 regmap_reg_range(M10BMC_FLASH_BASE, M10BMC_FLASH_END),
37 static const struct regmap_access_table m10bmc_access_table = {
38 .yes_ranges = m10bmc_regmap_range,
39 .n_yes_ranges = ARRAY_SIZE(m10bmc_regmap_range),
42 static struct regmap_config intel_m10bmc_regmap_config = {
46 .wr_table = &m10bmc_access_table,
47 .rd_table = &m10bmc_access_table,
48 .max_register = M10BMC_MEM_END,
51 static ssize_t bmc_version_show(struct device *dev,
52 struct device_attribute *attr, char *buf)
54 struct intel_m10bmc *ddata = dev_get_drvdata(dev);
58 ret = m10bmc_sys_read(ddata, M10BMC_BUILD_VER, &val);
62 return sprintf(buf, "0x%x\n", val);
64 static DEVICE_ATTR_RO(bmc_version);
66 static ssize_t bmcfw_version_show(struct device *dev,
67 struct device_attribute *attr, char *buf)
69 struct intel_m10bmc *ddata = dev_get_drvdata(dev);
73 ret = m10bmc_sys_read(ddata, NIOS2_FW_VERSION, &val);
77 return sprintf(buf, "0x%x\n", val);
79 static DEVICE_ATTR_RO(bmcfw_version);
81 static ssize_t mac_address_show(struct device *dev,
82 struct device_attribute *attr, char *buf)
84 struct intel_m10bmc *max10 = dev_get_drvdata(dev);
85 unsigned int macaddr_low, macaddr_high;
88 ret = m10bmc_sys_read(max10, M10BMC_MAC_LOW, &macaddr_low);
92 ret = m10bmc_sys_read(max10, M10BMC_MAC_HIGH, &macaddr_high);
96 return sysfs_emit(buf, "%02x:%02x:%02x:%02x:%02x:%02x\n",
97 (u8)FIELD_GET(M10BMC_MAC_BYTE1, macaddr_low),
98 (u8)FIELD_GET(M10BMC_MAC_BYTE2, macaddr_low),
99 (u8)FIELD_GET(M10BMC_MAC_BYTE3, macaddr_low),
100 (u8)FIELD_GET(M10BMC_MAC_BYTE4, macaddr_low),
101 (u8)FIELD_GET(M10BMC_MAC_BYTE5, macaddr_high),
102 (u8)FIELD_GET(M10BMC_MAC_BYTE6, macaddr_high));
104 static DEVICE_ATTR_RO(mac_address);
106 static ssize_t mac_count_show(struct device *dev,
107 struct device_attribute *attr, char *buf)
109 struct intel_m10bmc *max10 = dev_get_drvdata(dev);
110 unsigned int macaddr_high;
113 ret = m10bmc_sys_read(max10, M10BMC_MAC_HIGH, &macaddr_high);
117 return sysfs_emit(buf, "%u\n",
118 (u8)FIELD_GET(M10BMC_MAC_COUNT, macaddr_high));
120 static DEVICE_ATTR_RO(mac_count);
122 static struct attribute *m10bmc_attrs[] = {
123 &dev_attr_bmc_version.attr,
124 &dev_attr_bmcfw_version.attr,
125 &dev_attr_mac_address.attr,
126 &dev_attr_mac_count.attr,
129 ATTRIBUTE_GROUPS(m10bmc);
131 static int check_m10bmc_version(struct intel_m10bmc *ddata)
137 * This check is to filter out the very old legacy BMC versions. In the
138 * old BMC chips, the BMC version info is stored in the old version
139 * register (M10BMC_LEGACY_BUILD_VER), so its read out value would have
140 * not been M10BMC_VER_LEGACY_INVALID (0xffffffff). But in new BMC
141 * chips that the driver supports, the value of this register should be
142 * M10BMC_VER_LEGACY_INVALID.
144 ret = m10bmc_raw_read(ddata, M10BMC_LEGACY_BUILD_VER, &v);
148 if (v != M10BMC_VER_LEGACY_INVALID) {
149 dev_err(ddata->dev, "bad version M10BMC detected\n");
156 static int intel_m10_bmc_spi_probe(struct spi_device *spi)
158 const struct spi_device_id *id = spi_get_device_id(spi);
159 struct device *dev = &spi->dev;
160 struct mfd_cell *cells;
161 struct intel_m10bmc *ddata;
164 ddata = devm_kzalloc(dev, sizeof(*ddata), GFP_KERNEL);
171 devm_regmap_init_spi_avmm(spi, &intel_m10bmc_regmap_config);
172 if (IS_ERR(ddata->regmap)) {
173 ret = PTR_ERR(ddata->regmap);
174 dev_err(dev, "Failed to allocate regmap: %d\n", ret);
178 spi_set_drvdata(spi, ddata);
180 ret = check_m10bmc_version(ddata);
182 dev_err(dev, "Failed to identify m10bmc hardware\n");
186 switch (id->driver_data) {
188 cells = m10bmc_pacn3000_subdevs;
189 n_cell = ARRAY_SIZE(m10bmc_pacn3000_subdevs);
192 cells = m10bmc_d5005_subdevs;
193 n_cell = ARRAY_SIZE(m10bmc_d5005_subdevs);
199 ret = devm_mfd_add_devices(dev, PLATFORM_DEVID_AUTO, cells, n_cell,
202 dev_err(dev, "Failed to register sub-devices: %d\n", ret);
207 static const struct spi_device_id m10bmc_spi_id[] = {
208 { "m10-n3000", M10_N3000 },
209 { "m10-d5005", M10_D5005 },
212 MODULE_DEVICE_TABLE(spi, m10bmc_spi_id);
214 static struct spi_driver intel_m10bmc_spi_driver = {
216 .name = "intel-m10-bmc",
217 .dev_groups = m10bmc_groups,
219 .probe = intel_m10_bmc_spi_probe,
220 .id_table = m10bmc_spi_id,
222 module_spi_driver(intel_m10bmc_spi_driver);
224 MODULE_DESCRIPTION("Intel MAX 10 BMC Device Driver");
225 MODULE_AUTHOR("Intel Corporation");
226 MODULE_LICENSE("GPL v2");
227 MODULE_ALIAS("spi:intel-m10-bmc");