1 // SPDX-License-Identifier: GPL-2.0-only 2 /* 3 * Copyright (c) 2014, The Linux Foundation. All rights reserved. 4 */ 5 6 #include <linux/device.h> 7 #include <linux/errno.h> 8 #include <linux/gfp.h> 9 #include <linux/kernel.h> 10 #include <linux/module.h> 11 #include <linux/spmi.h> 12 #include <linux/types.h> 13 #include <linux/regmap.h> 14 #include <linux/of_platform.h> 15 #include <soc/qcom/qcom-spmi-pmic.h> 16 17 #define PMIC_REV2 0x101 18 #define PMIC_REV3 0x102 19 #define PMIC_REV4 0x103 20 #define PMIC_TYPE 0x104 21 #define PMIC_SUBTYPE 0x105 22 #define PMIC_FAB_ID 0x1f2 23 24 #define PMIC_TYPE_VALUE 0x51 25 26 #define PMIC_REV4_V2 0x02 27 28 struct qcom_spmi_dev { 29 int num_usids; 30 struct qcom_spmi_pmic pmic; 31 }; 32 33 #define N_USIDS(n) ((void *)n) 34 35 static const struct of_device_id pmic_spmi_id_table[] = { 36 { .compatible = "qcom,pm660", .data = N_USIDS(2) }, 37 { .compatible = "qcom,pm660l", .data = N_USIDS(2) }, 38 { .compatible = "qcom,pm8004", .data = N_USIDS(2) }, 39 { .compatible = "qcom,pm8005", .data = N_USIDS(2) }, 40 { .compatible = "qcom,pm8019", .data = N_USIDS(2) }, 41 { .compatible = "qcom,pm8028", .data = N_USIDS(2) }, 42 { .compatible = "qcom,pm8110", .data = N_USIDS(2) }, 43 { .compatible = "qcom,pm8150", .data = N_USIDS(2) }, 44 { .compatible = "qcom,pm8150b", .data = N_USIDS(2) }, 45 { .compatible = "qcom,pm8150c", .data = N_USIDS(2) }, 46 { .compatible = "qcom,pm8150l", .data = N_USIDS(2) }, 47 { .compatible = "qcom,pm8226", .data = N_USIDS(2) }, 48 { .compatible = "qcom,pm8841", .data = N_USIDS(2) }, 49 { .compatible = "qcom,pm8901", .data = N_USIDS(2) }, 50 { .compatible = "qcom,pm8909", .data = N_USIDS(2) }, 51 { .compatible = "qcom,pm8916", .data = N_USIDS(2) }, 52 { .compatible = "qcom,pm8941", .data = N_USIDS(2) }, 53 { .compatible = "qcom,pm8950", .data = N_USIDS(2) }, 54 { .compatible = "qcom,pm8994", .data = N_USIDS(2) }, 55 { .compatible = "qcom,pm8998", .data = N_USIDS(2) }, 56 { .compatible = "qcom,pma8084", .data = N_USIDS(2) }, 57 { .compatible = "qcom,pmd9635", .data = N_USIDS(2) }, 58 { .compatible = "qcom,pmi8950", .data = N_USIDS(2) }, 59 { .compatible = "qcom,pmi8962", .data = N_USIDS(2) }, 60 { .compatible = "qcom,pmi8994", .data = N_USIDS(2) }, 61 { .compatible = "qcom,pmi8998", .data = N_USIDS(2) }, 62 { .compatible = "qcom,pmk8002", .data = N_USIDS(2) }, 63 { .compatible = "qcom,smb2351", .data = N_USIDS(2) }, 64 { .compatible = "qcom,spmi-pmic", .data = N_USIDS(1) }, 65 { } 66 }; 67 68 /* 69 * A PMIC can be represented by multiple SPMI devices, but 70 * only the base PMIC device will contain a reference to 71 * the revision information. 72 * 73 * This function takes a pointer to a pmic device and 74 * returns a pointer to the base PMIC device. 75 * 76 * This only supports PMICs with 1 or 2 USIDs. 77 */ 78 static struct spmi_device *qcom_pmic_get_base_usid(struct device *dev) 79 { 80 struct spmi_device *sdev; 81 struct qcom_spmi_dev *ctx; 82 struct device_node *spmi_bus; 83 struct device_node *other_usid = NULL; 84 int function_parent_usid, ret; 85 u32 pmic_addr; 86 87 sdev = to_spmi_device(dev); 88 ctx = dev_get_drvdata(&sdev->dev); 89 90 /* 91 * Quick return if the function device is already in the base 92 * USID. This will always be hit for PMICs with only 1 USID. 93 */ 94 if (sdev->usid % ctx->num_usids == 0) 95 return sdev; 96 97 function_parent_usid = sdev->usid; 98 99 /* 100 * Walk through the list of PMICs until we find the sibling USID. 101 * The goal is to find the first USID which is less than the 102 * number of USIDs in the PMIC array, e.g. for a PMIC with 2 USIDs 103 * where the function device is under USID 3, we want to find the 104 * device for USID 2. 105 */ 106 spmi_bus = of_get_parent(sdev->dev.of_node); 107 do { 108 other_usid = of_get_next_child(spmi_bus, other_usid); 109 110 ret = of_property_read_u32_index(other_usid, "reg", 0, &pmic_addr); 111 if (ret) 112 return ERR_PTR(ret); 113 114 sdev = spmi_device_from_of(other_usid); 115 if (pmic_addr == function_parent_usid - (ctx->num_usids - 1)) { 116 if (!sdev) 117 /* 118 * If the base USID for this PMIC hasn't probed yet 119 * but the secondary USID has, then we need to defer 120 * the function driver so that it will attempt to 121 * probe again when the base USID is ready. 122 */ 123 return ERR_PTR(-EPROBE_DEFER); 124 return sdev; 125 } 126 } while (other_usid->sibling); 127 128 return ERR_PTR(-ENODATA); 129 } 130 131 static int pmic_spmi_load_revid(struct regmap *map, struct device *dev, 132 struct qcom_spmi_pmic *pmic) 133 { 134 int ret; 135 136 ret = regmap_read(map, PMIC_TYPE, &pmic->type); 137 if (ret < 0) 138 return ret; 139 140 if (pmic->type != PMIC_TYPE_VALUE) 141 return ret; 142 143 ret = regmap_read(map, PMIC_SUBTYPE, &pmic->subtype); 144 if (ret < 0) 145 return ret; 146 147 pmic->name = of_match_device(pmic_spmi_id_table, dev)->compatible; 148 149 ret = regmap_read(map, PMIC_REV2, &pmic->rev2); 150 if (ret < 0) 151 return ret; 152 153 ret = regmap_read(map, PMIC_REV3, &pmic->minor); 154 if (ret < 0) 155 return ret; 156 157 ret = regmap_read(map, PMIC_REV4, &pmic->major); 158 if (ret < 0) 159 return ret; 160 161 if (pmic->subtype == PMI8998_SUBTYPE || pmic->subtype == PM660_SUBTYPE) { 162 ret = regmap_read(map, PMIC_FAB_ID, &pmic->fab_id); 163 if (ret < 0) 164 return ret; 165 } 166 167 /* 168 * In early versions of PM8941 and PM8226, the major revision number 169 * started incrementing from 0 (eg 0 = v1.0, 1 = v2.0). 170 * Increment the major revision number here if the chip is an early 171 * version of PM8941 or PM8226. 172 */ 173 if ((pmic->subtype == PM8941_SUBTYPE || pmic->subtype == PM8226_SUBTYPE) && 174 pmic->major < PMIC_REV4_V2) 175 pmic->major++; 176 177 if (pmic->subtype == PM8110_SUBTYPE) 178 pmic->minor = pmic->rev2; 179 180 dev_dbg(dev, "%x: %s v%d.%d\n", 181 pmic->subtype, pmic->name, pmic->major, pmic->minor); 182 183 return 0; 184 } 185 186 /** 187 * qcom_pmic_get() - Get a pointer to the base PMIC device 188 * 189 * This function takes a struct device for a driver which is a child of a PMIC. 190 * And locates the PMIC revision information for it. 191 * 192 * @dev: the pmic function device 193 * @return: the struct qcom_spmi_pmic* pointer associated with the function device 194 */ 195 const struct qcom_spmi_pmic *qcom_pmic_get(struct device *dev) 196 { 197 struct spmi_device *sdev; 198 struct qcom_spmi_dev *spmi; 199 200 /* 201 * Make sure the device is actually a child of a PMIC 202 */ 203 if (!of_match_device(pmic_spmi_id_table, dev->parent)) 204 return ERR_PTR(-EINVAL); 205 206 sdev = qcom_pmic_get_base_usid(dev->parent); 207 208 if (IS_ERR(sdev)) 209 return ERR_CAST(sdev); 210 211 spmi = dev_get_drvdata(&sdev->dev); 212 213 return &spmi->pmic; 214 } 215 EXPORT_SYMBOL(qcom_pmic_get); 216 217 static const struct regmap_config spmi_regmap_config = { 218 .reg_bits = 16, 219 .val_bits = 8, 220 .max_register = 0xffff, 221 .fast_io = true, 222 }; 223 224 static int pmic_spmi_probe(struct spmi_device *sdev) 225 { 226 struct regmap *regmap; 227 struct qcom_spmi_dev *ctx; 228 int ret; 229 230 regmap = devm_regmap_init_spmi_ext(sdev, &spmi_regmap_config); 231 if (IS_ERR(regmap)) 232 return PTR_ERR(regmap); 233 234 ctx = devm_kzalloc(&sdev->dev, sizeof(*ctx), GFP_KERNEL); 235 if (!ctx) 236 return -ENOMEM; 237 238 ctx->num_usids = (uintptr_t)of_device_get_match_data(&sdev->dev); 239 240 /* Only the first slave id for a PMIC contains this information */ 241 if (sdev->usid % ctx->num_usids == 0) { 242 ret = pmic_spmi_load_revid(regmap, &sdev->dev, &ctx->pmic); 243 if (ret < 0) 244 return ret; 245 } 246 spmi_device_set_drvdata(sdev, ctx); 247 248 return devm_of_platform_populate(&sdev->dev); 249 } 250 251 MODULE_DEVICE_TABLE(of, pmic_spmi_id_table); 252 253 static struct spmi_driver pmic_spmi_driver = { 254 .probe = pmic_spmi_probe, 255 .driver = { 256 .name = "pmic-spmi", 257 .of_match_table = pmic_spmi_id_table, 258 }, 259 }; 260 module_spmi_driver(pmic_spmi_driver); 261 262 MODULE_DESCRIPTION("Qualcomm SPMI PMIC driver"); 263 MODULE_ALIAS("spmi:spmi-pmic"); 264 MODULE_LICENSE("GPL v2"); 265 MODULE_AUTHOR("Josh Cartwright <joshc@codeaurora.org>"); 266 MODULE_AUTHOR("Stanimir Varbanov <svarbanov@mm-sol.com>"); 267