Linux Audio

Check our new training course

Loading...
v6.8
   1// SPDX-License-Identifier: GPL-2.0-or-later
   2/*
   3 * g762 - Driver for the Global Mixed-mode Technology Inc. fan speed
   4 *        PWM controller chips from G762 family, i.e. G762 and G763
   5 *
   6 * Copyright (C) 2013, Arnaud EBALARD <arno@natisbad.org>
   7 *
   8 * This work is based on a basic version for 2.6.31 kernel developed
   9 * by Olivier Mouchet for LaCie. Updates and correction have been
  10 * performed to run on recent kernels. Additional features, like the
  11 * ability to configure various characteristics via .dts file or
  12 * board init file have been added. Detailed datasheet on which this
  13 * development is based is available here:
  14 *
  15 *  http://natisbad.org/NAS/refs/GMT_EDS-762_763-080710-0.2.pdf
  16 *
  17 * Headers from previous developments have been kept below:
  18 *
  19 * Copyright (c) 2009 LaCie
  20 *
  21 * Author: Olivier Mouchet <olivier.mouchet@gmail.com>
  22 *
  23 * based on g760a code written by Herbert Valerio Riedel <hvr@gnu.org>
  24 * Copyright (C) 2007  Herbert Valerio Riedel <hvr@gnu.org>
  25 *
  26 * g762: minimal datasheet available at:
  27 *       http://www.gmt.com.tw/product/datasheet/EDS-762_3.pdf
 
 
 
 
 
 
 
 
 
 
 
 
 
 
  28 */
  29
  30#include <linux/device.h>
  31#include <linux/module.h>
  32#include <linux/init.h>
  33#include <linux/jiffies.h>
  34#include <linux/i2c.h>
  35#include <linux/hwmon.h>
  36#include <linux/hwmon-sysfs.h>
  37#include <linux/err.h>
  38#include <linux/mutex.h>
  39#include <linux/kernel.h>
  40#include <linux/clk.h>
  41#include <linux/of.h>
 
  42#include <linux/platform_data/g762.h>
  43
  44#define DRVNAME "g762"
  45
  46static const struct i2c_device_id g762_id[] = {
  47	{ "g762", 0 },
  48	{ "g763", 0 },
  49	{ }
  50};
  51MODULE_DEVICE_TABLE(i2c, g762_id);
  52
  53enum g762_regs {
  54	G762_REG_SET_CNT  = 0x00,
  55	G762_REG_ACT_CNT  = 0x01,
  56	G762_REG_FAN_STA  = 0x02,
  57	G762_REG_SET_OUT  = 0x03,
  58	G762_REG_FAN_CMD1 = 0x04,
  59	G762_REG_FAN_CMD2 = 0x05,
  60};
  61
  62/* Config register bits */
  63#define G762_REG_FAN_CMD1_DET_FAN_FAIL  0x80 /* enable fan_fail signal */
  64#define G762_REG_FAN_CMD1_DET_FAN_OOC   0x40 /* enable fan_out_of_control */
  65#define G762_REG_FAN_CMD1_OUT_MODE      0x20 /* out mode: PWM or DC */
  66#define G762_REG_FAN_CMD1_FAN_MODE      0x10 /* fan mode: closed/open-loop */
  67#define G762_REG_FAN_CMD1_CLK_DIV_ID1   0x08 /* clock divisor value */
  68#define G762_REG_FAN_CMD1_CLK_DIV_ID0   0x04
  69#define G762_REG_FAN_CMD1_PWM_POLARITY  0x02 /* PWM polarity */
  70#define G762_REG_FAN_CMD1_PULSE_PER_REV 0x01 /* pulse per fan revolution */
  71
  72#define G762_REG_FAN_CMD2_GEAR_MODE_1   0x08 /* fan gear mode */
  73#define G762_REG_FAN_CMD2_GEAR_MODE_0   0x04
  74#define G762_REG_FAN_CMD2_FAN_STARTV_1  0x02 /* fan startup voltage */
  75#define G762_REG_FAN_CMD2_FAN_STARTV_0  0x01
  76
  77#define G762_REG_FAN_STA_FAIL           0x02 /* fan fail */
  78#define G762_REG_FAN_STA_OOC            0x01 /* fan out of control */
  79
  80/* Config register values */
  81#define G762_OUT_MODE_PWM            1
  82#define G762_OUT_MODE_DC             0
  83
  84#define G762_FAN_MODE_CLOSED_LOOP    2
  85#define G762_FAN_MODE_OPEN_LOOP      1
  86
  87#define G762_PWM_POLARITY_NEGATIVE   1
  88#define G762_PWM_POLARITY_POSITIVE   0
  89
  90/* Register data is read (and cached) at most once per second. */
  91#define G762_UPDATE_INTERVAL    HZ
  92
  93/*
  94 * Extract pulse count per fan revolution value (2 or 4) from given
  95 * FAN_CMD1 register value.
  96 */
  97#define G762_PULSE_FROM_REG(reg) \
  98	((((reg) & G762_REG_FAN_CMD1_PULSE_PER_REV) + 1) << 1)
  99
 100/*
 101 * Extract fan clock divisor (1, 2, 4 or 8) from given FAN_CMD1
 102 * register value.
 103 */
 104#define G762_CLKDIV_FROM_REG(reg) \
 105	(1 << (((reg) & (G762_REG_FAN_CMD1_CLK_DIV_ID0 |	\
 106			 G762_REG_FAN_CMD1_CLK_DIV_ID1)) >> 2))
 107
 108/*
 109 * Extract fan gear mode multiplier value (0, 2 or 4) from given
 110 * FAN_CMD2 register value.
 111 */
 112#define G762_GEARMULT_FROM_REG(reg) \
 113	(1 << (((reg) & (G762_REG_FAN_CMD2_GEAR_MODE_0 |	\
 114			 G762_REG_FAN_CMD2_GEAR_MODE_1)) >> 2))
 115
 116struct g762_data {
 
 117	struct i2c_client *client;
 118	struct clk *clk;
 119
 120	/* update mutex */
 121	struct mutex update_lock;
 122
 123	/* board specific parameters. */
 124	u32 clk_freq;
 125
 126	/* g762 register cache */
 127	bool valid;
 128	unsigned long last_updated; /* in jiffies */
 129
 130	u8 set_cnt;  /* controls fan rotation speed in closed-loop mode */
 131	u8 act_cnt;  /* provides access to current fan RPM value */
 132	u8 fan_sta;  /* bit 0: set when actual fan speed is more than
 133		      *        25% outside requested fan speed
 134		      * bit 1: set when no transition occurs on fan
 135		      *        pin for 0.7s
 136		      */
 137	u8 set_out;  /* controls fan rotation speed in open-loop mode */
 138	u8 fan_cmd1; /*   0: FG_PLS_ID0 FG pulses count per revolution
 139		      *      0: 2 counts per revolution
 140		      *      1: 4 counts per revolution
 141		      *   1: PWM_POLARITY 1: negative_duty
 142		      *                   0: positive_duty
 143		      * 2,3: [FG_CLOCK_ID0, FG_CLK_ID1]
 144		      *         00: Divide fan clock by 1
 145		      *         01: Divide fan clock by 2
 146		      *         10: Divide fan clock by 4
 147		      *         11: Divide fan clock by 8
 148		      *   4: FAN_MODE 1:closed-loop, 0:open-loop
 149		      *   5: OUT_MODE 1:PWM, 0:DC
 150		      *   6: DET_FAN_OOC enable "fan ooc" status
 151		      *   7: DET_FAN_FAIL enable "fan fail" status
 152		      */
 153	u8 fan_cmd2; /* 0,1: FAN_STARTV 0,1,2,3 -> 0,32,64,96 dac_code
 154		      * 2,3: FG_GEAR_MODE
 155		      *         00: multiplier = 1
 156		      *         01: multiplier = 2
 157		      *         10: multiplier = 4
 158		      *   4: Mask ALERT# (g763 only)
 159		      */
 160};
 161
 162/*
 163 * Convert count value from fan controller register (FAN_SET_CNT) into fan
 164 * speed RPM value. Note that the datasheet documents a basic formula;
 165 * influence of additional parameters (fan clock divisor, fan gear mode)
 166 * have been infered from examples in the datasheet and tests.
 167 */
 168static inline unsigned int rpm_from_cnt(u8 cnt, u32 clk_freq, u16 p,
 169					u8 clk_div, u8 gear_mult)
 170{
 171	if (cnt == 0xff)  /* setting cnt to 255 stops the fan */
 172		return 0;
 173
 174	return (clk_freq * 30 * gear_mult) / ((cnt ? cnt : 1) * p * clk_div);
 175}
 176
 177/*
 178 * Convert fan RPM value from sysfs into count value for fan controller
 179 * register (FAN_SET_CNT).
 180 */
 181static inline unsigned char cnt_from_rpm(unsigned long rpm, u32 clk_freq, u16 p,
 182					 u8 clk_div, u8 gear_mult)
 183{
 184	unsigned long f1 = clk_freq * 30 * gear_mult;
 185	unsigned long f2 = p * clk_div;
 186
 187	if (!rpm)	/* to stop the fan, set cnt to 255 */
 188		return 0xff;
 189
 190	rpm = clamp_val(rpm, f1 / (255 * f2), ULONG_MAX / f2);
 191	return DIV_ROUND_CLOSEST(f1, rpm * f2);
 192}
 193
 194/* helper to grab and cache data, at most one time per second */
 195static struct g762_data *g762_update_client(struct device *dev)
 196{
 197	struct g762_data *data = dev_get_drvdata(dev);
 198	struct i2c_client *client = data->client;
 199	int ret = 0;
 200
 201	mutex_lock(&data->update_lock);
 202	if (time_before(jiffies, data->last_updated + G762_UPDATE_INTERVAL) &&
 203	    likely(data->valid))
 204		goto out;
 205
 206	ret = i2c_smbus_read_byte_data(client, G762_REG_SET_CNT);
 207	if (ret < 0)
 208		goto out;
 209	data->set_cnt = ret;
 210
 211	ret = i2c_smbus_read_byte_data(client, G762_REG_ACT_CNT);
 212	if (ret < 0)
 213		goto out;
 214	data->act_cnt = ret;
 215
 216	ret = i2c_smbus_read_byte_data(client, G762_REG_FAN_STA);
 217	if (ret < 0)
 218		goto out;
 219	data->fan_sta = ret;
 220
 221	ret = i2c_smbus_read_byte_data(client, G762_REG_SET_OUT);
 222	if (ret < 0)
 223		goto out;
 224	data->set_out = ret;
 225
 226	ret = i2c_smbus_read_byte_data(client, G762_REG_FAN_CMD1);
 227	if (ret < 0)
 228		goto out;
 229	data->fan_cmd1 = ret;
 230
 231	ret = i2c_smbus_read_byte_data(client, G762_REG_FAN_CMD2);
 232	if (ret < 0)
 233		goto out;
 234	data->fan_cmd2 = ret;
 235
 236	data->last_updated = jiffies;
 237	data->valid = true;
 238 out:
 239	mutex_unlock(&data->update_lock);
 240
 241	if (ret < 0) /* upon error, encode it in return value */
 242		data = ERR_PTR(ret);
 243
 244	return data;
 245}
 246
 247/* helpers for writing hardware parameters */
 248
 249/*
 250 * Set input clock frequency received on CLK pin of the chip. Accepted values
 251 * are between 0 and 0xffffff. If zero is given, then default frequency
 252 * (32,768Hz) is used. Note that clock frequency is a characteristic of the
 253 * system but an internal parameter, i.e. value is not passed to the device.
 254 */
 255static int do_set_clk_freq(struct device *dev, unsigned long val)
 256{
 257	struct g762_data *data = dev_get_drvdata(dev);
 258
 259	if (val > 0xffffff)
 260		return -EINVAL;
 261	if (!val)
 262		val = 32768;
 263
 264	data->clk_freq = val;
 265
 266	return 0;
 267}
 268
 269/* Set pwm mode. Accepts either 0 (PWM mode) or 1 (DC mode) */
 270static int do_set_pwm_mode(struct device *dev, unsigned long val)
 271{
 272	struct g762_data *data = g762_update_client(dev);
 273	int ret;
 274
 275	if (IS_ERR(data))
 276		return PTR_ERR(data);
 277
 278	mutex_lock(&data->update_lock);
 279	switch (val) {
 280	case G762_OUT_MODE_PWM:
 281		data->fan_cmd1 |=  G762_REG_FAN_CMD1_OUT_MODE;
 282		break;
 283	case G762_OUT_MODE_DC:
 284		data->fan_cmd1 &= ~G762_REG_FAN_CMD1_OUT_MODE;
 285		break;
 286	default:
 287		ret = -EINVAL;
 288		goto out;
 289	}
 290	ret = i2c_smbus_write_byte_data(data->client, G762_REG_FAN_CMD1,
 291					data->fan_cmd1);
 292	data->valid = false;
 293 out:
 294	mutex_unlock(&data->update_lock);
 295
 296	return ret;
 297}
 298
 299/* Set fan clock divisor. Accepts either 1, 2, 4 or 8. */
 300static int do_set_fan_div(struct device *dev, unsigned long val)
 301{
 302	struct g762_data *data = g762_update_client(dev);
 303	int ret;
 304
 305	if (IS_ERR(data))
 306		return PTR_ERR(data);
 307
 308	mutex_lock(&data->update_lock);
 309	switch (val) {
 310	case 1:
 311		data->fan_cmd1 &= ~G762_REG_FAN_CMD1_CLK_DIV_ID0;
 312		data->fan_cmd1 &= ~G762_REG_FAN_CMD1_CLK_DIV_ID1;
 313		break;
 314	case 2:
 315		data->fan_cmd1 |=  G762_REG_FAN_CMD1_CLK_DIV_ID0;
 316		data->fan_cmd1 &= ~G762_REG_FAN_CMD1_CLK_DIV_ID1;
 317		break;
 318	case 4:
 319		data->fan_cmd1 &= ~G762_REG_FAN_CMD1_CLK_DIV_ID0;
 320		data->fan_cmd1 |=  G762_REG_FAN_CMD1_CLK_DIV_ID1;
 321		break;
 322	case 8:
 323		data->fan_cmd1 |=  G762_REG_FAN_CMD1_CLK_DIV_ID0;
 324		data->fan_cmd1 |=  G762_REG_FAN_CMD1_CLK_DIV_ID1;
 325		break;
 326	default:
 327		ret = -EINVAL;
 328		goto out;
 329	}
 330	ret = i2c_smbus_write_byte_data(data->client, G762_REG_FAN_CMD1,
 331					data->fan_cmd1);
 332	data->valid = false;
 333 out:
 334	mutex_unlock(&data->update_lock);
 335
 336	return ret;
 337}
 338
 339/* Set fan gear mode. Accepts either 0, 1 or 2. */
 340static int do_set_fan_gear_mode(struct device *dev, unsigned long val)
 341{
 342	struct g762_data *data = g762_update_client(dev);
 343	int ret;
 344
 345	if (IS_ERR(data))
 346		return PTR_ERR(data);
 347
 348	mutex_lock(&data->update_lock);
 349	switch (val) {
 350	case 0:
 351		data->fan_cmd2 &= ~G762_REG_FAN_CMD2_GEAR_MODE_0;
 352		data->fan_cmd2 &= ~G762_REG_FAN_CMD2_GEAR_MODE_1;
 353		break;
 354	case 1:
 355		data->fan_cmd2 |=  G762_REG_FAN_CMD2_GEAR_MODE_0;
 356		data->fan_cmd2 &= ~G762_REG_FAN_CMD2_GEAR_MODE_1;
 357		break;
 358	case 2:
 359		data->fan_cmd2 &= ~G762_REG_FAN_CMD2_GEAR_MODE_0;
 360		data->fan_cmd2 |=  G762_REG_FAN_CMD2_GEAR_MODE_1;
 361		break;
 362	default:
 363		ret = -EINVAL;
 364		goto out;
 365	}
 366	ret = i2c_smbus_write_byte_data(data->client, G762_REG_FAN_CMD2,
 367					data->fan_cmd2);
 368	data->valid = false;
 369 out:
 370	mutex_unlock(&data->update_lock);
 371
 372	return ret;
 373}
 374
 375/* Set number of fan pulses per revolution. Accepts either 2 or 4. */
 376static int do_set_fan_pulses(struct device *dev, unsigned long val)
 377{
 378	struct g762_data *data = g762_update_client(dev);
 379	int ret;
 380
 381	if (IS_ERR(data))
 382		return PTR_ERR(data);
 383
 384	mutex_lock(&data->update_lock);
 385	switch (val) {
 386	case 2:
 387		data->fan_cmd1 &= ~G762_REG_FAN_CMD1_PULSE_PER_REV;
 388		break;
 389	case 4:
 390		data->fan_cmd1 |=  G762_REG_FAN_CMD1_PULSE_PER_REV;
 391		break;
 392	default:
 393		ret = -EINVAL;
 394		goto out;
 395	}
 396	ret = i2c_smbus_write_byte_data(data->client, G762_REG_FAN_CMD1,
 397					data->fan_cmd1);
 398	data->valid = false;
 399 out:
 400	mutex_unlock(&data->update_lock);
 401
 402	return ret;
 403}
 404
 405/* Set fan mode. Accepts either 1 (open-loop) or 2 (closed-loop). */
 406static int do_set_pwm_enable(struct device *dev, unsigned long val)
 407{
 408	struct g762_data *data = g762_update_client(dev);
 409	int ret;
 410
 411	if (IS_ERR(data))
 412		return PTR_ERR(data);
 413
 414	mutex_lock(&data->update_lock);
 415	switch (val) {
 416	case G762_FAN_MODE_CLOSED_LOOP:
 417		data->fan_cmd1 |=  G762_REG_FAN_CMD1_FAN_MODE;
 418		break;
 419	case G762_FAN_MODE_OPEN_LOOP:
 420		data->fan_cmd1 &= ~G762_REG_FAN_CMD1_FAN_MODE;
 421		/*
 422		 * BUG FIX: if SET_CNT register value is 255 then, for some
 423		 * unknown reason, fan will not rotate as expected, no matter
 424		 * the value of SET_OUT (to be specific, this seems to happen
 425		 * only in PWM mode). To workaround this bug, we give SET_CNT
 426		 * value of 254 if it is 255 when switching to open-loop.
 427		 */
 428		if (data->set_cnt == 0xff)
 429			i2c_smbus_write_byte_data(data->client,
 430						  G762_REG_SET_CNT, 254);
 431		break;
 432	default:
 433		ret = -EINVAL;
 434		goto out;
 435	}
 436
 437	ret = i2c_smbus_write_byte_data(data->client, G762_REG_FAN_CMD1,
 438					data->fan_cmd1);
 439	data->valid = false;
 440 out:
 441	mutex_unlock(&data->update_lock);
 442
 443	return ret;
 444}
 445
 446/* Set PWM polarity. Accepts either 0 (positive duty) or 1 (negative duty) */
 447static int do_set_pwm_polarity(struct device *dev, unsigned long val)
 448{
 449	struct g762_data *data = g762_update_client(dev);
 450	int ret;
 451
 452	if (IS_ERR(data))
 453		return PTR_ERR(data);
 454
 455	mutex_lock(&data->update_lock);
 456	switch (val) {
 457	case G762_PWM_POLARITY_POSITIVE:
 458		data->fan_cmd1 &= ~G762_REG_FAN_CMD1_PWM_POLARITY;
 459		break;
 460	case G762_PWM_POLARITY_NEGATIVE:
 461		data->fan_cmd1 |=  G762_REG_FAN_CMD1_PWM_POLARITY;
 462		break;
 463	default:
 464		ret = -EINVAL;
 465		goto out;
 466	}
 467	ret = i2c_smbus_write_byte_data(data->client, G762_REG_FAN_CMD1,
 468					data->fan_cmd1);
 469	data->valid = false;
 470 out:
 471	mutex_unlock(&data->update_lock);
 472
 473	return ret;
 474}
 475
 476/*
 477 * Set pwm value. Accepts values between 0 (stops the fan) and
 478 * 255 (full speed). This only makes sense in open-loop mode.
 479 */
 480static int do_set_pwm(struct device *dev, unsigned long val)
 481{
 482	struct g762_data *data = dev_get_drvdata(dev);
 483	struct i2c_client *client = data->client;
 484	int ret;
 485
 486	if (val > 255)
 487		return -EINVAL;
 488
 489	mutex_lock(&data->update_lock);
 490	ret = i2c_smbus_write_byte_data(client, G762_REG_SET_OUT, val);
 491	data->valid = false;
 492	mutex_unlock(&data->update_lock);
 493
 494	return ret;
 495}
 496
 497/*
 498 * Set fan RPM value. Can be called both in closed and open-loop mode
 499 * but effect will only be seen after closed-loop mode is configured.
 500 */
 501static int do_set_fan_target(struct device *dev, unsigned long val)
 502{
 503	struct g762_data *data = g762_update_client(dev);
 504	int ret;
 505
 506	if (IS_ERR(data))
 507		return PTR_ERR(data);
 508
 509	mutex_lock(&data->update_lock);
 510	data->set_cnt = cnt_from_rpm(val, data->clk_freq,
 511				     G762_PULSE_FROM_REG(data->fan_cmd1),
 512				     G762_CLKDIV_FROM_REG(data->fan_cmd1),
 513				     G762_GEARMULT_FROM_REG(data->fan_cmd2));
 514	ret = i2c_smbus_write_byte_data(data->client, G762_REG_SET_CNT,
 515					data->set_cnt);
 516	data->valid = false;
 517	mutex_unlock(&data->update_lock);
 518
 519	return ret;
 520}
 521
 522/* Set fan startup voltage. Accepted values are either 0, 1, 2 or 3. */
 523static int do_set_fan_startv(struct device *dev, unsigned long val)
 524{
 525	struct g762_data *data = g762_update_client(dev);
 526	int ret;
 527
 528	if (IS_ERR(data))
 529		return PTR_ERR(data);
 530
 531	mutex_lock(&data->update_lock);
 532	switch (val) {
 533	case 0:
 534		data->fan_cmd2 &= ~G762_REG_FAN_CMD2_FAN_STARTV_0;
 535		data->fan_cmd2 &= ~G762_REG_FAN_CMD2_FAN_STARTV_1;
 536		break;
 537	case 1:
 538		data->fan_cmd2 |=  G762_REG_FAN_CMD2_FAN_STARTV_0;
 539		data->fan_cmd2 &= ~G762_REG_FAN_CMD2_FAN_STARTV_1;
 540		break;
 541	case 2:
 542		data->fan_cmd2 &= ~G762_REG_FAN_CMD2_FAN_STARTV_0;
 543		data->fan_cmd2 |=  G762_REG_FAN_CMD2_FAN_STARTV_1;
 544		break;
 545	case 3:
 546		data->fan_cmd2 |=  G762_REG_FAN_CMD2_FAN_STARTV_0;
 547		data->fan_cmd2 |=  G762_REG_FAN_CMD2_FAN_STARTV_1;
 548		break;
 549	default:
 550		ret = -EINVAL;
 551		goto out;
 552	}
 553	ret = i2c_smbus_write_byte_data(data->client, G762_REG_FAN_CMD2,
 554					data->fan_cmd2);
 555	data->valid = false;
 556 out:
 557	mutex_unlock(&data->update_lock);
 558
 559	return ret;
 560}
 561
 562/*
 563 * Helper to import hardware characteristics from .dts file and push
 564 * those to the chip.
 565 */
 566
 567#ifdef CONFIG_OF
 568static const struct of_device_id g762_dt_match[] = {
 569	{ .compatible = "gmt,g762" },
 570	{ .compatible = "gmt,g763" },
 571	{ },
 572};
 573MODULE_DEVICE_TABLE(of, g762_dt_match);
 574
 575/*
 576 * Grab clock (a required property), enable it, get (fixed) clock frequency
 577 * and store it. Note: upon success, clock has been prepared and enabled; it
 578 * must later be unprepared and disabled (e.g. during module unloading) by a
 579 * call to g762_of_clock_disable(). Note that a reference to clock is kept
 580 * in our private data structure to be used in this function.
 581 */
 582static void g762_of_clock_disable(void *data)
 583{
 584	struct g762_data *g762 = data;
 585
 586	clk_disable_unprepare(g762->clk);
 587	clk_put(g762->clk);
 588}
 589
 590static int g762_of_clock_enable(struct i2c_client *client)
 591{
 592	struct g762_data *data;
 593	unsigned long clk_freq;
 594	struct clk *clk;
 595	int ret;
 596
 597	if (!client->dev.of_node)
 598		return 0;
 599
 600	clk = of_clk_get(client->dev.of_node, 0);
 601	if (IS_ERR(clk)) {
 602		dev_err(&client->dev, "failed to get clock\n");
 603		return PTR_ERR(clk);
 604	}
 605
 606	ret = clk_prepare_enable(clk);
 607	if (ret) {
 608		dev_err(&client->dev, "failed to enable clock\n");
 609		goto clk_put;
 610	}
 611
 612	clk_freq = clk_get_rate(clk);
 613	ret = do_set_clk_freq(&client->dev, clk_freq);
 614	if (ret) {
 615		dev_err(&client->dev, "invalid clock freq %lu\n", clk_freq);
 616		goto clk_unprep;
 617	}
 618
 619	data = i2c_get_clientdata(client);
 620	data->clk = clk;
 621
 622	ret = devm_add_action(&client->dev, g762_of_clock_disable, data);
 623	if (ret) {
 624		dev_err(&client->dev, "failed to add disable clock action\n");
 625		goto clk_unprep;
 626	}
 627
 628	return 0;
 629
 630 clk_unprep:
 631	clk_disable_unprepare(clk);
 632
 633 clk_put:
 634	clk_put(clk);
 635
 636	return ret;
 637}
 638
 
 
 
 
 
 
 
 
 
 
 
 639static int g762_of_prop_import_one(struct i2c_client *client,
 640				   const char *pname,
 641				   int (*psetter)(struct device *dev,
 642						  unsigned long val))
 643{
 644	int ret;
 645	u32 pval;
 646
 647	if (of_property_read_u32(client->dev.of_node, pname, &pval))
 648		return 0;
 649
 650	dev_dbg(&client->dev, "found %s (%d)\n", pname, pval);
 651	ret = (*psetter)(&client->dev, pval);
 652	if (ret)
 653		dev_err(&client->dev, "unable to set %s (%d)\n", pname, pval);
 654
 655	return ret;
 656}
 657
 658static int g762_of_prop_import(struct i2c_client *client)
 659{
 660	int ret;
 661
 662	if (!client->dev.of_node)
 663		return 0;
 664
 665	ret = g762_of_prop_import_one(client, "fan_gear_mode",
 666				      do_set_fan_gear_mode);
 667	if (ret)
 668		return ret;
 669
 670	ret = g762_of_prop_import_one(client, "pwm_polarity",
 671				      do_set_pwm_polarity);
 672	if (ret)
 673		return ret;
 674
 675	return g762_of_prop_import_one(client, "fan_startv",
 676				       do_set_fan_startv);
 677}
 678
 679#else
 680static int g762_of_prop_import(struct i2c_client *client)
 681{
 682	return 0;
 683}
 684
 685static int g762_of_clock_enable(struct i2c_client *client)
 686{
 687	return 0;
 688}
 
 
 689#endif
 690
 691/*
 692 * Helper to import hardware characteristics from .dts file and push
 693 * those to the chip.
 694 */
 695
 696static int g762_pdata_prop_import(struct i2c_client *client)
 697{
 698	struct g762_platform_data *pdata = dev_get_platdata(&client->dev);
 699	int ret;
 700
 701	if (!pdata)
 702		return 0;
 703
 704	ret = do_set_fan_gear_mode(&client->dev, pdata->fan_gear_mode);
 705	if (ret)
 706		return ret;
 707
 708	ret = do_set_pwm_polarity(&client->dev, pdata->pwm_polarity);
 709	if (ret)
 710		return ret;
 711
 712	ret = do_set_fan_startv(&client->dev, pdata->fan_startv);
 713	if (ret)
 714		return ret;
 715
 716	return do_set_clk_freq(&client->dev, pdata->clk_freq);
 717}
 718
 719/*
 720 * sysfs attributes
 721 */
 722
 723/*
 724 * Read function for fan1_input sysfs file. Return current fan RPM value, or
 725 * 0 if fan is out of control.
 726 */
 727static ssize_t fan1_input_show(struct device *dev,
 728			       struct device_attribute *da, char *buf)
 729{
 730	struct g762_data *data = g762_update_client(dev);
 731	unsigned int rpm = 0;
 732
 733	if (IS_ERR(data))
 734		return PTR_ERR(data);
 735
 736	mutex_lock(&data->update_lock);
 737	/* reverse logic: fan out of control reporting is enabled low */
 738	if (data->fan_sta & G762_REG_FAN_STA_OOC) {
 739		rpm = rpm_from_cnt(data->act_cnt, data->clk_freq,
 740				   G762_PULSE_FROM_REG(data->fan_cmd1),
 741				   G762_CLKDIV_FROM_REG(data->fan_cmd1),
 742				   G762_GEARMULT_FROM_REG(data->fan_cmd2));
 743	}
 744	mutex_unlock(&data->update_lock);
 745
 746	return sprintf(buf, "%u\n", rpm);
 747}
 748
 749/*
 750 * Read and write functions for pwm1_mode sysfs file. Get and set fan speed
 751 * control mode i.e. PWM (1) or DC (0).
 752 */
 753static ssize_t pwm1_mode_show(struct device *dev, struct device_attribute *da,
 754			      char *buf)
 755{
 756	struct g762_data *data = g762_update_client(dev);
 757
 758	if (IS_ERR(data))
 759		return PTR_ERR(data);
 760
 761	return sprintf(buf, "%d\n",
 762		       !!(data->fan_cmd1 & G762_REG_FAN_CMD1_OUT_MODE));
 763}
 764
 765static ssize_t pwm1_mode_store(struct device *dev,
 766			       struct device_attribute *da, const char *buf,
 767			       size_t count)
 768{
 769	unsigned long val;
 770	int ret;
 771
 772	if (kstrtoul(buf, 10, &val))
 773		return -EINVAL;
 774
 775	ret = do_set_pwm_mode(dev, val);
 776	if (ret < 0)
 777		return ret;
 778
 779	return count;
 780}
 781
 782/*
 783 * Read and write functions for fan1_div sysfs file. Get and set fan
 784 * controller prescaler value
 785 */
 786static ssize_t fan1_div_show(struct device *dev, struct device_attribute *da,
 787			     char *buf)
 788{
 789	struct g762_data *data = g762_update_client(dev);
 790
 791	if (IS_ERR(data))
 792		return PTR_ERR(data);
 793
 794	return sprintf(buf, "%d\n", G762_CLKDIV_FROM_REG(data->fan_cmd1));
 795}
 796
 797static ssize_t fan1_div_store(struct device *dev, struct device_attribute *da,
 798			      const char *buf, size_t count)
 
 799{
 800	unsigned long val;
 801	int ret;
 802
 803	if (kstrtoul(buf, 10, &val))
 804		return -EINVAL;
 805
 806	ret = do_set_fan_div(dev, val);
 807	if (ret < 0)
 808		return ret;
 809
 810	return count;
 811}
 812
 813/*
 814 * Read and write functions for fan1_pulses sysfs file. Get and set number
 815 * of tachometer pulses per fan revolution.
 816 */
 817static ssize_t fan1_pulses_show(struct device *dev,
 818				struct device_attribute *da, char *buf)
 819{
 820	struct g762_data *data = g762_update_client(dev);
 821
 822	if (IS_ERR(data))
 823		return PTR_ERR(data);
 824
 825	return sprintf(buf, "%d\n", G762_PULSE_FROM_REG(data->fan_cmd1));
 826}
 827
 828static ssize_t fan1_pulses_store(struct device *dev,
 829				 struct device_attribute *da, const char *buf,
 830				 size_t count)
 831{
 832	unsigned long val;
 833	int ret;
 834
 835	if (kstrtoul(buf, 10, &val))
 836		return -EINVAL;
 837
 838	ret = do_set_fan_pulses(dev, val);
 839	if (ret < 0)
 840		return ret;
 841
 842	return count;
 843}
 844
 845/*
 846 * Read and write functions for pwm1_enable. Get and set fan speed control mode
 847 * (i.e. closed or open-loop).
 848 *
 849 * Following documentation about hwmon's sysfs interface, a pwm1_enable node
 850 * should accept the following:
 851 *
 852 *  0 : no fan speed control (i.e. fan at full speed)
 853 *  1 : manual fan speed control enabled (use pwm[1-*]) (open-loop)
 854 *  2+: automatic fan speed control enabled (use fan[1-*]_target) (closed-loop)
 855 *
 856 * but we do not accept 0 as this mode is not natively supported by the chip
 857 * and it is not emulated by g762 driver. -EINVAL is returned in this case.
 858 */
 859static ssize_t pwm1_enable_show(struct device *dev,
 860				struct device_attribute *da, char *buf)
 861{
 862	struct g762_data *data = g762_update_client(dev);
 863
 864	if (IS_ERR(data))
 865		return PTR_ERR(data);
 866
 867	return sprintf(buf, "%d\n",
 868		       (!!(data->fan_cmd1 & G762_REG_FAN_CMD1_FAN_MODE)) + 1);
 869}
 870
 871static ssize_t pwm1_enable_store(struct device *dev,
 872				 struct device_attribute *da, const char *buf,
 873				 size_t count)
 874{
 875	unsigned long val;
 876	int ret;
 877
 878	if (kstrtoul(buf, 10, &val))
 879		return -EINVAL;
 880
 881	ret = do_set_pwm_enable(dev, val);
 882	if (ret < 0)
 883		return ret;
 884
 885	return count;
 886}
 887
 888/*
 889 * Read and write functions for pwm1 sysfs file. Get and set pwm value
 890 * (which affects fan speed) in open-loop mode. 0 stops the fan and 255
 891 * makes it run at full speed.
 892 */
 893static ssize_t pwm1_show(struct device *dev, struct device_attribute *da,
 894			 char *buf)
 895{
 896	struct g762_data *data = g762_update_client(dev);
 897
 898	if (IS_ERR(data))
 899		return PTR_ERR(data);
 900
 901	return sprintf(buf, "%d\n", data->set_out);
 902}
 903
 904static ssize_t pwm1_store(struct device *dev, struct device_attribute *da,
 905			  const char *buf, size_t count)
 906{
 907	unsigned long val;
 908	int ret;
 909
 910	if (kstrtoul(buf, 10, &val))
 911		return -EINVAL;
 912
 913	ret = do_set_pwm(dev, val);
 914	if (ret < 0)
 915		return ret;
 916
 917	return count;
 918}
 919
 920/*
 921 * Read and write function for fan1_target sysfs file. Get/set the fan speed in
 922 * closed-loop mode. Speed is given as a RPM value; then the chip will regulate
 923 * the fan speed using pulses from fan tachometer.
 924 *
 925 * Refer to rpm_from_cnt() implementation above to get info about count number
 926 * calculation.
 927 *
 928 * Also note that due to rounding errors it is possible that you don't read
 929 * back exactly the value you have set.
 930 */
 931static ssize_t fan1_target_show(struct device *dev,
 932				struct device_attribute *da, char *buf)
 933{
 934	struct g762_data *data = g762_update_client(dev);
 935	unsigned int rpm;
 936
 937	if (IS_ERR(data))
 938		return PTR_ERR(data);
 939
 940	mutex_lock(&data->update_lock);
 941	rpm = rpm_from_cnt(data->set_cnt, data->clk_freq,
 942			   G762_PULSE_FROM_REG(data->fan_cmd1),
 943			   G762_CLKDIV_FROM_REG(data->fan_cmd1),
 944			   G762_GEARMULT_FROM_REG(data->fan_cmd2));
 945	mutex_unlock(&data->update_lock);
 946
 947	return sprintf(buf, "%u\n", rpm);
 948}
 949
 950static ssize_t fan1_target_store(struct device *dev,
 951				 struct device_attribute *da, const char *buf,
 952				 size_t count)
 953{
 954	unsigned long val;
 955	int ret;
 956
 957	if (kstrtoul(buf, 10, &val))
 958		return -EINVAL;
 959
 960	ret = do_set_fan_target(dev, val);
 961	if (ret < 0)
 962		return ret;
 963
 964	return count;
 965}
 966
 967/* read function for fan1_fault sysfs file. */
 968static ssize_t fan1_fault_show(struct device *dev, struct device_attribute *da,
 969			       char *buf)
 970{
 971	struct g762_data *data = g762_update_client(dev);
 972
 973	if (IS_ERR(data))
 974		return PTR_ERR(data);
 975
 976	return sprintf(buf, "%u\n", !!(data->fan_sta & G762_REG_FAN_STA_FAIL));
 977}
 978
 979/*
 980 * read function for fan1_alarm sysfs file. Note that OOC condition is
 981 * enabled low
 982 */
 983static ssize_t fan1_alarm_show(struct device *dev,
 984			       struct device_attribute *da, char *buf)
 985{
 986	struct g762_data *data = g762_update_client(dev);
 987
 988	if (IS_ERR(data))
 989		return PTR_ERR(data);
 990
 991	return sprintf(buf, "%u\n", !(data->fan_sta & G762_REG_FAN_STA_OOC));
 992}
 993
 994static DEVICE_ATTR_RW(pwm1);
 995static DEVICE_ATTR_RW(pwm1_mode);
 996static DEVICE_ATTR_RW(pwm1_enable);
 997static DEVICE_ATTR_RO(fan1_input);
 998static DEVICE_ATTR_RO(fan1_alarm);
 999static DEVICE_ATTR_RO(fan1_fault);
1000static DEVICE_ATTR_RW(fan1_target);
1001static DEVICE_ATTR_RW(fan1_div);
1002static DEVICE_ATTR_RW(fan1_pulses);
 
 
 
1003
1004/* Driver data */
1005static struct attribute *g762_attrs[] = {
1006	&dev_attr_fan1_input.attr,
1007	&dev_attr_fan1_alarm.attr,
1008	&dev_attr_fan1_fault.attr,
1009	&dev_attr_fan1_target.attr,
1010	&dev_attr_fan1_div.attr,
1011	&dev_attr_fan1_pulses.attr,
1012	&dev_attr_pwm1.attr,
1013	&dev_attr_pwm1_mode.attr,
1014	&dev_attr_pwm1_enable.attr,
1015	NULL
1016};
1017
1018ATTRIBUTE_GROUPS(g762);
1019
1020/*
1021 * Enable both fan failure detection and fan out of control protection. The
1022 * function does not protect change/access to data structure; it must thus
1023 * only be called during initialization.
1024 */
1025static inline int g762_fan_init(struct device *dev)
1026{
1027	struct g762_data *data = g762_update_client(dev);
1028
1029	if (IS_ERR(data))
1030		return PTR_ERR(data);
1031
1032	data->fan_cmd1 |= G762_REG_FAN_CMD1_DET_FAN_FAIL;
1033	data->fan_cmd1 |= G762_REG_FAN_CMD1_DET_FAN_OOC;
1034	data->valid = false;
1035
1036	return i2c_smbus_write_byte_data(data->client, G762_REG_FAN_CMD1,
1037					 data->fan_cmd1);
1038}
1039
1040static int g762_probe(struct i2c_client *client)
1041{
1042	struct device *dev = &client->dev;
1043	struct device *hwmon_dev;
1044	struct g762_data *data;
1045	int ret;
1046
1047	if (!i2c_check_functionality(client->adapter,
1048				     I2C_FUNC_SMBUS_BYTE_DATA))
1049		return -ENODEV;
1050
1051	data = devm_kzalloc(dev, sizeof(struct g762_data), GFP_KERNEL);
1052	if (!data)
1053		return -ENOMEM;
1054
1055	i2c_set_clientdata(client, data);
1056	data->client = client;
1057	mutex_init(&data->update_lock);
1058
1059	/* Enable fan failure detection and fan out of control protection */
1060	ret = g762_fan_init(dev);
1061	if (ret)
1062		return ret;
1063
1064	/* Get configuration via DT ... */
1065	ret = g762_of_clock_enable(client);
1066	if (ret)
1067		return ret;
1068	ret = g762_of_prop_import(client);
1069	if (ret)
1070		return ret;
1071	/* ... or platform_data */
1072	ret = g762_pdata_prop_import(client);
1073	if (ret)
1074		return ret;
1075
1076	hwmon_dev = devm_hwmon_device_register_with_groups(dev, client->name,
1077							    data, g762_groups);
1078	return PTR_ERR_OR_ZERO(hwmon_dev);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1079}
1080
1081static struct i2c_driver g762_driver = {
1082	.driver = {
1083		.name = DRVNAME,
1084		.of_match_table = of_match_ptr(g762_dt_match),
1085	},
1086	.probe = g762_probe,
 
1087	.id_table = g762_id,
1088};
1089
1090module_i2c_driver(g762_driver);
1091
1092MODULE_AUTHOR("Arnaud EBALARD <arno@natisbad.org>");
1093MODULE_DESCRIPTION("GMT G762/G763 driver");
1094MODULE_LICENSE("GPL");
v4.6
 
   1/*
   2 * g762 - Driver for the Global Mixed-mode Technology Inc. fan speed
   3 *        PWM controller chips from G762 family, i.e. G762 and G763
   4 *
   5 * Copyright (C) 2013, Arnaud EBALARD <arno@natisbad.org>
   6 *
   7 * This work is based on a basic version for 2.6.31 kernel developed
   8 * by Olivier Mouchet for LaCie. Updates and correction have been
   9 * performed to run on recent kernels. Additional features, like the
  10 * ability to configure various characteristics via .dts file or
  11 * board init file have been added. Detailed datasheet on which this
  12 * development is based is available here:
  13 *
  14 *  http://natisbad.org/NAS/refs/GMT_EDS-762_763-080710-0.2.pdf
  15 *
  16 * Headers from previous developments have been kept below:
  17 *
  18 * Copyright (c) 2009 LaCie
  19 *
  20 * Author: Olivier Mouchet <olivier.mouchet@gmail.com>
  21 *
  22 * based on g760a code written by Herbert Valerio Riedel <hvr@gnu.org>
  23 * Copyright (C) 2007  Herbert Valerio Riedel <hvr@gnu.org>
  24 *
  25 * g762: minimal datasheet available at:
  26 *       http://www.gmt.com.tw/product/datasheet/EDS-762_3.pdf
  27 *
  28 * This program is free software; you can redistribute it and/or modify
  29 * it under the terms of the GNU General Public License as published by
  30 * the Free Software Foundation; either version 2 of the License, or
  31 * (at your option) any later version.
  32 *
  33 * This program is distributed in the hope that it will be useful,
  34 * but WITHOUT ANY WARRANTY; without even the implied warranty of
  35 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  36 * GNU General Public License for more details.
  37 *
  38 * You should have received a copy of the GNU General Public License
  39 * along with this program; if not, write to the Free Software
  40 * Foundation.
  41 */
  42
  43#include <linux/device.h>
  44#include <linux/module.h>
  45#include <linux/init.h>
  46#include <linux/jiffies.h>
  47#include <linux/i2c.h>
  48#include <linux/hwmon.h>
  49#include <linux/hwmon-sysfs.h>
  50#include <linux/err.h>
  51#include <linux/mutex.h>
  52#include <linux/kernel.h>
  53#include <linux/clk.h>
  54#include <linux/of.h>
  55#include <linux/of_device.h>
  56#include <linux/platform_data/g762.h>
  57
  58#define DRVNAME "g762"
  59
  60static const struct i2c_device_id g762_id[] = {
  61	{ "g762", 0 },
  62	{ "g763", 0 },
  63	{ }
  64};
  65MODULE_DEVICE_TABLE(i2c, g762_id);
  66
  67enum g762_regs {
  68	G762_REG_SET_CNT  = 0x00,
  69	G762_REG_ACT_CNT  = 0x01,
  70	G762_REG_FAN_STA  = 0x02,
  71	G762_REG_SET_OUT  = 0x03,
  72	G762_REG_FAN_CMD1 = 0x04,
  73	G762_REG_FAN_CMD2 = 0x05,
  74};
  75
  76/* Config register bits */
  77#define G762_REG_FAN_CMD1_DET_FAN_FAIL  0x80 /* enable fan_fail signal */
  78#define G762_REG_FAN_CMD1_DET_FAN_OOC   0x40 /* enable fan_out_of_control */
  79#define G762_REG_FAN_CMD1_OUT_MODE      0x20 /* out mode: PWM or DC */
  80#define G762_REG_FAN_CMD1_FAN_MODE      0x10 /* fan mode: closed/open-loop */
  81#define G762_REG_FAN_CMD1_CLK_DIV_ID1   0x08 /* clock divisor value */
  82#define G762_REG_FAN_CMD1_CLK_DIV_ID0   0x04
  83#define G762_REG_FAN_CMD1_PWM_POLARITY  0x02 /* PWM polarity */
  84#define G762_REG_FAN_CMD1_PULSE_PER_REV 0x01 /* pulse per fan revolution */
  85
  86#define G762_REG_FAN_CMD2_GEAR_MODE_1   0x08 /* fan gear mode */
  87#define G762_REG_FAN_CMD2_GEAR_MODE_0   0x04
  88#define G762_REG_FAN_CMD2_FAN_STARTV_1  0x02 /* fan startup voltage */
  89#define G762_REG_FAN_CMD2_FAN_STARTV_0  0x01
  90
  91#define G762_REG_FAN_STA_FAIL           0x02 /* fan fail */
  92#define G762_REG_FAN_STA_OOC            0x01 /* fan out of control */
  93
  94/* Config register values */
  95#define G762_OUT_MODE_PWM            1
  96#define G762_OUT_MODE_DC             0
  97
  98#define G762_FAN_MODE_CLOSED_LOOP    2
  99#define G762_FAN_MODE_OPEN_LOOP      1
 100
 101#define G762_PWM_POLARITY_NEGATIVE   1
 102#define G762_PWM_POLARITY_POSITIVE   0
 103
 104/* Register data is read (and cached) at most once per second. */
 105#define G762_UPDATE_INTERVAL    HZ
 106
 107/*
 108 * Extract pulse count per fan revolution value (2 or 4) from given
 109 * FAN_CMD1 register value.
 110 */
 111#define G762_PULSE_FROM_REG(reg) \
 112	((((reg) & G762_REG_FAN_CMD1_PULSE_PER_REV) + 1) << 1)
 113
 114/*
 115 * Extract fan clock divisor (1, 2, 4 or 8) from given FAN_CMD1
 116 * register value.
 117 */
 118#define G762_CLKDIV_FROM_REG(reg) \
 119	(1 << (((reg) & (G762_REG_FAN_CMD1_CLK_DIV_ID0 |	\
 120			 G762_REG_FAN_CMD1_CLK_DIV_ID1)) >> 2))
 121
 122/*
 123 * Extract fan gear mode multiplier value (0, 2 or 4) from given
 124 * FAN_CMD2 register value.
 125 */
 126#define G762_GEARMULT_FROM_REG(reg) \
 127	(1 << (((reg) & (G762_REG_FAN_CMD2_GEAR_MODE_0 |	\
 128			 G762_REG_FAN_CMD2_GEAR_MODE_1)) >> 2))
 129
 130struct g762_data {
 131	struct device *hwmon_dev;
 132	struct i2c_client *client;
 133	struct clk *clk;
 134
 135	/* update mutex */
 136	struct mutex update_lock;
 137
 138	/* board specific parameters. */
 139	u32 clk_freq;
 140
 141	/* g762 register cache */
 142	bool valid;
 143	unsigned long last_updated; /* in jiffies */
 144
 145	u8 set_cnt;  /* controls fan rotation speed in closed-loop mode */
 146	u8 act_cnt;  /* provides access to current fan RPM value */
 147	u8 fan_sta;  /* bit 0: set when actual fan speed is more than
 148		      *        25% outside requested fan speed
 149		      * bit 1: set when no transition occurs on fan
 150		      *        pin for 0.7s
 151		      */
 152	u8 set_out;  /* controls fan rotation speed in open-loop mode */
 153	u8 fan_cmd1; /*   0: FG_PLS_ID0 FG pulses count per revolution
 154		      *      0: 2 counts per revolution
 155		      *      1: 4 counts per revolution
 156		      *   1: PWM_POLARITY 1: negative_duty
 157		      *                   0: positive_duty
 158		      * 2,3: [FG_CLOCK_ID0, FG_CLK_ID1]
 159		      *         00: Divide fan clock by 1
 160		      *         01: Divide fan clock by 2
 161		      *         10: Divide fan clock by 4
 162		      *         11: Divide fan clock by 8
 163		      *   4: FAN_MODE 1:closed-loop, 0:open-loop
 164		      *   5: OUT_MODE 1:PWM, 0:DC
 165		      *   6: DET_FAN_OOC enable "fan ooc" status
 166		      *   7: DET_FAN_FAIL enable "fan fail" status
 167		      */
 168	u8 fan_cmd2; /* 0,1: FAN_STARTV 0,1,2,3 -> 0,32,64,96 dac_code
 169		      * 2,3: FG_GEAR_MODE
 170		      *         00: multiplier = 1
 171		      *         01: multiplier = 2
 172		      *         10: multiplier = 4
 173		      *   4: Mask ALERT# (g763 only)
 174		      */
 175};
 176
 177/*
 178 * Convert count value from fan controller register (FAN_SET_CNT) into fan
 179 * speed RPM value. Note that the datasheet documents a basic formula;
 180 * influence of additional parameters (fan clock divisor, fan gear mode)
 181 * have been infered from examples in the datasheet and tests.
 182 */
 183static inline unsigned int rpm_from_cnt(u8 cnt, u32 clk_freq, u16 p,
 184					u8 clk_div, u8 gear_mult)
 185{
 186	if (cnt == 0xff)  /* setting cnt to 255 stops the fan */
 187		return 0;
 188
 189	return (clk_freq * 30 * gear_mult) / ((cnt ? cnt : 1) * p * clk_div);
 190}
 191
 192/*
 193 * Convert fan RPM value from sysfs into count value for fan controller
 194 * register (FAN_SET_CNT).
 195 */
 196static inline unsigned char cnt_from_rpm(u32 rpm, u32 clk_freq, u16 p,
 197					 u8 clk_div, u8 gear_mult)
 198{
 199	if (!rpm)         /* to stop the fan, set cnt to 255 */
 
 
 
 200		return 0xff;
 201
 202	return clamp_val(((clk_freq * 30 * gear_mult) / (rpm * p * clk_div)),
 203			 0, 255);
 204}
 205
 206/* helper to grab and cache data, at most one time per second */
 207static struct g762_data *g762_update_client(struct device *dev)
 208{
 209	struct g762_data *data = dev_get_drvdata(dev);
 210	struct i2c_client *client = data->client;
 211	int ret = 0;
 212
 213	mutex_lock(&data->update_lock);
 214	if (time_before(jiffies, data->last_updated + G762_UPDATE_INTERVAL) &&
 215	    likely(data->valid))
 216		goto out;
 217
 218	ret = i2c_smbus_read_byte_data(client, G762_REG_SET_CNT);
 219	if (ret < 0)
 220		goto out;
 221	data->set_cnt = ret;
 222
 223	ret = i2c_smbus_read_byte_data(client, G762_REG_ACT_CNT);
 224	if (ret < 0)
 225		goto out;
 226	data->act_cnt = ret;
 227
 228	ret = i2c_smbus_read_byte_data(client, G762_REG_FAN_STA);
 229	if (ret < 0)
 230		goto out;
 231	data->fan_sta = ret;
 232
 233	ret = i2c_smbus_read_byte_data(client, G762_REG_SET_OUT);
 234	if (ret < 0)
 235		goto out;
 236	data->set_out = ret;
 237
 238	ret = i2c_smbus_read_byte_data(client, G762_REG_FAN_CMD1);
 239	if (ret < 0)
 240		goto out;
 241	data->fan_cmd1 = ret;
 242
 243	ret = i2c_smbus_read_byte_data(client, G762_REG_FAN_CMD2);
 244	if (ret < 0)
 245		goto out;
 246	data->fan_cmd2 = ret;
 247
 248	data->last_updated = jiffies;
 249	data->valid = true;
 250 out:
 251	mutex_unlock(&data->update_lock);
 252
 253	if (ret < 0) /* upon error, encode it in return value */
 254		data = ERR_PTR(ret);
 255
 256	return data;
 257}
 258
 259/* helpers for writing hardware parameters */
 260
 261/*
 262 * Set input clock frequency received on CLK pin of the chip. Accepted values
 263 * are between 0 and 0xffffff. If zero is given, then default frequency
 264 * (32,768Hz) is used. Note that clock frequency is a characteristic of the
 265 * system but an internal parameter, i.e. value is not passed to the device.
 266 */
 267static int do_set_clk_freq(struct device *dev, unsigned long val)
 268{
 269	struct g762_data *data = dev_get_drvdata(dev);
 270
 271	if (val > 0xffffff)
 272		return -EINVAL;
 273	if (!val)
 274		val = 32768;
 275
 276	data->clk_freq = val;
 277
 278	return 0;
 279}
 280
 281/* Set pwm mode. Accepts either 0 (PWM mode) or 1 (DC mode) */
 282static int do_set_pwm_mode(struct device *dev, unsigned long val)
 283{
 284	struct g762_data *data = g762_update_client(dev);
 285	int ret;
 286
 287	if (IS_ERR(data))
 288		return PTR_ERR(data);
 289
 290	mutex_lock(&data->update_lock);
 291	switch (val) {
 292	case G762_OUT_MODE_PWM:
 293		data->fan_cmd1 |=  G762_REG_FAN_CMD1_OUT_MODE;
 294		break;
 295	case G762_OUT_MODE_DC:
 296		data->fan_cmd1 &= ~G762_REG_FAN_CMD1_OUT_MODE;
 297		break;
 298	default:
 299		ret = -EINVAL;
 300		goto out;
 301	}
 302	ret = i2c_smbus_write_byte_data(data->client, G762_REG_FAN_CMD1,
 303					data->fan_cmd1);
 304	data->valid = false;
 305 out:
 306	mutex_unlock(&data->update_lock);
 307
 308	return ret;
 309}
 310
 311/* Set fan clock divisor. Accepts either 1, 2, 4 or 8. */
 312static int do_set_fan_div(struct device *dev, unsigned long val)
 313{
 314	struct g762_data *data = g762_update_client(dev);
 315	int ret;
 316
 317	if (IS_ERR(data))
 318		return PTR_ERR(data);
 319
 320	mutex_lock(&data->update_lock);
 321	switch (val) {
 322	case 1:
 323		data->fan_cmd1 &= ~G762_REG_FAN_CMD1_CLK_DIV_ID0;
 324		data->fan_cmd1 &= ~G762_REG_FAN_CMD1_CLK_DIV_ID1;
 325		break;
 326	case 2:
 327		data->fan_cmd1 |=  G762_REG_FAN_CMD1_CLK_DIV_ID0;
 328		data->fan_cmd1 &= ~G762_REG_FAN_CMD1_CLK_DIV_ID1;
 329		break;
 330	case 4:
 331		data->fan_cmd1 &= ~G762_REG_FAN_CMD1_CLK_DIV_ID0;
 332		data->fan_cmd1 |=  G762_REG_FAN_CMD1_CLK_DIV_ID1;
 333		break;
 334	case 8:
 335		data->fan_cmd1 |=  G762_REG_FAN_CMD1_CLK_DIV_ID0;
 336		data->fan_cmd1 |=  G762_REG_FAN_CMD1_CLK_DIV_ID1;
 337		break;
 338	default:
 339		ret = -EINVAL;
 340		goto out;
 341	}
 342	ret = i2c_smbus_write_byte_data(data->client, G762_REG_FAN_CMD1,
 343					data->fan_cmd1);
 344	data->valid = false;
 345 out:
 346	mutex_unlock(&data->update_lock);
 347
 348	return ret;
 349}
 350
 351/* Set fan gear mode. Accepts either 0, 1 or 2. */
 352static int do_set_fan_gear_mode(struct device *dev, unsigned long val)
 353{
 354	struct g762_data *data = g762_update_client(dev);
 355	int ret;
 356
 357	if (IS_ERR(data))
 358		return PTR_ERR(data);
 359
 360	mutex_lock(&data->update_lock);
 361	switch (val) {
 362	case 0:
 363		data->fan_cmd2 &= ~G762_REG_FAN_CMD2_GEAR_MODE_0;
 364		data->fan_cmd2 &= ~G762_REG_FAN_CMD2_GEAR_MODE_1;
 365		break;
 366	case 1:
 367		data->fan_cmd2 |=  G762_REG_FAN_CMD2_GEAR_MODE_0;
 368		data->fan_cmd2 &= ~G762_REG_FAN_CMD2_GEAR_MODE_1;
 369		break;
 370	case 2:
 371		data->fan_cmd2 &= ~G762_REG_FAN_CMD2_GEAR_MODE_0;
 372		data->fan_cmd2 |=  G762_REG_FAN_CMD2_GEAR_MODE_1;
 373		break;
 374	default:
 375		ret = -EINVAL;
 376		goto out;
 377	}
 378	ret = i2c_smbus_write_byte_data(data->client, G762_REG_FAN_CMD2,
 379					data->fan_cmd2);
 380	data->valid = false;
 381 out:
 382	mutex_unlock(&data->update_lock);
 383
 384	return ret;
 385}
 386
 387/* Set number of fan pulses per revolution. Accepts either 2 or 4. */
 388static int do_set_fan_pulses(struct device *dev, unsigned long val)
 389{
 390	struct g762_data *data = g762_update_client(dev);
 391	int ret;
 392
 393	if (IS_ERR(data))
 394		return PTR_ERR(data);
 395
 396	mutex_lock(&data->update_lock);
 397	switch (val) {
 398	case 2:
 399		data->fan_cmd1 &= ~G762_REG_FAN_CMD1_PULSE_PER_REV;
 400		break;
 401	case 4:
 402		data->fan_cmd1 |=  G762_REG_FAN_CMD1_PULSE_PER_REV;
 403		break;
 404	default:
 405		ret = -EINVAL;
 406		goto out;
 407	}
 408	ret = i2c_smbus_write_byte_data(data->client, G762_REG_FAN_CMD1,
 409					data->fan_cmd1);
 410	data->valid = false;
 411 out:
 412	mutex_unlock(&data->update_lock);
 413
 414	return ret;
 415}
 416
 417/* Set fan mode. Accepts either 1 (open-loop) or 2 (closed-loop). */
 418static int do_set_pwm_enable(struct device *dev, unsigned long val)
 419{
 420	struct g762_data *data = g762_update_client(dev);
 421	int ret;
 422
 423	if (IS_ERR(data))
 424		return PTR_ERR(data);
 425
 426	mutex_lock(&data->update_lock);
 427	switch (val) {
 428	case G762_FAN_MODE_CLOSED_LOOP:
 429		data->fan_cmd1 |=  G762_REG_FAN_CMD1_FAN_MODE;
 430		break;
 431	case G762_FAN_MODE_OPEN_LOOP:
 432		data->fan_cmd1 &= ~G762_REG_FAN_CMD1_FAN_MODE;
 433		/*
 434		 * BUG FIX: if SET_CNT register value is 255 then, for some
 435		 * unknown reason, fan will not rotate as expected, no matter
 436		 * the value of SET_OUT (to be specific, this seems to happen
 437		 * only in PWM mode). To workaround this bug, we give SET_CNT
 438		 * value of 254 if it is 255 when switching to open-loop.
 439		 */
 440		if (data->set_cnt == 0xff)
 441			i2c_smbus_write_byte_data(data->client,
 442						  G762_REG_SET_CNT, 254);
 443		break;
 444	default:
 445		ret = -EINVAL;
 446		goto out;
 447	}
 448
 449	ret = i2c_smbus_write_byte_data(data->client, G762_REG_FAN_CMD1,
 450					data->fan_cmd1);
 451	data->valid = false;
 452 out:
 453	mutex_unlock(&data->update_lock);
 454
 455	return ret;
 456}
 457
 458/* Set PWM polarity. Accepts either 0 (positive duty) or 1 (negative duty) */
 459static int do_set_pwm_polarity(struct device *dev, unsigned long val)
 460{
 461	struct g762_data *data = g762_update_client(dev);
 462	int ret;
 463
 464	if (IS_ERR(data))
 465		return PTR_ERR(data);
 466
 467	mutex_lock(&data->update_lock);
 468	switch (val) {
 469	case G762_PWM_POLARITY_POSITIVE:
 470		data->fan_cmd1 &= ~G762_REG_FAN_CMD1_PWM_POLARITY;
 471		break;
 472	case G762_PWM_POLARITY_NEGATIVE:
 473		data->fan_cmd1 |=  G762_REG_FAN_CMD1_PWM_POLARITY;
 474		break;
 475	default:
 476		ret = -EINVAL;
 477		goto out;
 478	}
 479	ret = i2c_smbus_write_byte_data(data->client, G762_REG_FAN_CMD1,
 480					data->fan_cmd1);
 481	data->valid = false;
 482 out:
 483	mutex_unlock(&data->update_lock);
 484
 485	return ret;
 486}
 487
 488/*
 489 * Set pwm value. Accepts values between 0 (stops the fan) and
 490 * 255 (full speed). This only makes sense in open-loop mode.
 491 */
 492static int do_set_pwm(struct device *dev, unsigned long val)
 493{
 494	struct g762_data *data = dev_get_drvdata(dev);
 495	struct i2c_client *client = data->client;
 496	int ret;
 497
 498	if (val > 255)
 499		return -EINVAL;
 500
 501	mutex_lock(&data->update_lock);
 502	ret = i2c_smbus_write_byte_data(client, G762_REG_SET_OUT, val);
 503	data->valid = false;
 504	mutex_unlock(&data->update_lock);
 505
 506	return ret;
 507}
 508
 509/*
 510 * Set fan RPM value. Can be called both in closed and open-loop mode
 511 * but effect will only be seen after closed-loop mode is configured.
 512 */
 513static int do_set_fan_target(struct device *dev, unsigned long val)
 514{
 515	struct g762_data *data = g762_update_client(dev);
 516	int ret;
 517
 518	if (IS_ERR(data))
 519		return PTR_ERR(data);
 520
 521	mutex_lock(&data->update_lock);
 522	data->set_cnt = cnt_from_rpm(val, data->clk_freq,
 523				     G762_PULSE_FROM_REG(data->fan_cmd1),
 524				     G762_CLKDIV_FROM_REG(data->fan_cmd1),
 525				     G762_GEARMULT_FROM_REG(data->fan_cmd2));
 526	ret = i2c_smbus_write_byte_data(data->client, G762_REG_SET_CNT,
 527					data->set_cnt);
 528	data->valid = false;
 529	mutex_unlock(&data->update_lock);
 530
 531	return ret;
 532}
 533
 534/* Set fan startup voltage. Accepted values are either 0, 1, 2 or 3. */
 535static int do_set_fan_startv(struct device *dev, unsigned long val)
 536{
 537	struct g762_data *data = g762_update_client(dev);
 538	int ret;
 539
 540	if (IS_ERR(data))
 541		return PTR_ERR(data);
 542
 543	mutex_lock(&data->update_lock);
 544	switch (val) {
 545	case 0:
 546		data->fan_cmd2 &= ~G762_REG_FAN_CMD2_FAN_STARTV_0;
 547		data->fan_cmd2 &= ~G762_REG_FAN_CMD2_FAN_STARTV_1;
 548		break;
 549	case 1:
 550		data->fan_cmd2 |=  G762_REG_FAN_CMD2_FAN_STARTV_0;
 551		data->fan_cmd2 &= ~G762_REG_FAN_CMD2_FAN_STARTV_1;
 552		break;
 553	case 2:
 554		data->fan_cmd2 &= ~G762_REG_FAN_CMD2_FAN_STARTV_0;
 555		data->fan_cmd2 |=  G762_REG_FAN_CMD2_FAN_STARTV_1;
 556		break;
 557	case 3:
 558		data->fan_cmd2 |=  G762_REG_FAN_CMD2_FAN_STARTV_0;
 559		data->fan_cmd2 |=  G762_REG_FAN_CMD2_FAN_STARTV_1;
 560		break;
 561	default:
 562		ret = -EINVAL;
 563		goto out;
 564	}
 565	ret = i2c_smbus_write_byte_data(data->client, G762_REG_FAN_CMD2,
 566					data->fan_cmd2);
 567	data->valid = false;
 568 out:
 569	mutex_unlock(&data->update_lock);
 570
 571	return ret;
 572}
 573
 574/*
 575 * Helper to import hardware characteristics from .dts file and push
 576 * those to the chip.
 577 */
 578
 579#ifdef CONFIG_OF
 580static const struct of_device_id g762_dt_match[] = {
 581	{ .compatible = "gmt,g762" },
 582	{ .compatible = "gmt,g763" },
 583	{ },
 584};
 585MODULE_DEVICE_TABLE(of, g762_dt_match);
 586
 587/*
 588 * Grab clock (a required property), enable it, get (fixed) clock frequency
 589 * and store it. Note: upon success, clock has been prepared and enabled; it
 590 * must later be unprepared and disabled (e.g. during module unloading) by a
 591 * call to g762_of_clock_disable(). Note that a reference to clock is kept
 592 * in our private data structure to be used in this function.
 593 */
 
 
 
 
 
 
 
 
 594static int g762_of_clock_enable(struct i2c_client *client)
 595{
 596	struct g762_data *data;
 597	unsigned long clk_freq;
 598	struct clk *clk;
 599	int ret;
 600
 601	if (!client->dev.of_node)
 602		return 0;
 603
 604	clk = of_clk_get(client->dev.of_node, 0);
 605	if (IS_ERR(clk)) {
 606		dev_err(&client->dev, "failed to get clock\n");
 607		return PTR_ERR(clk);
 608	}
 609
 610	ret = clk_prepare_enable(clk);
 611	if (ret) {
 612		dev_err(&client->dev, "failed to enable clock\n");
 613		goto clk_put;
 614	}
 615
 616	clk_freq = clk_get_rate(clk);
 617	ret = do_set_clk_freq(&client->dev, clk_freq);
 618	if (ret) {
 619		dev_err(&client->dev, "invalid clock freq %lu\n", clk_freq);
 620		goto clk_unprep;
 621	}
 622
 623	data = i2c_get_clientdata(client);
 624	data->clk = clk;
 625
 
 
 
 
 
 
 626	return 0;
 627
 628 clk_unprep:
 629	clk_disable_unprepare(clk);
 630
 631 clk_put:
 632	clk_put(clk);
 633
 634	return ret;
 635}
 636
 637static void g762_of_clock_disable(struct i2c_client *client)
 638{
 639	struct g762_data *data = i2c_get_clientdata(client);
 640
 641	if (!data->clk)
 642		return;
 643
 644	clk_disable_unprepare(data->clk);
 645	clk_put(data->clk);
 646}
 647
 648static int g762_of_prop_import_one(struct i2c_client *client,
 649				   const char *pname,
 650				   int (*psetter)(struct device *dev,
 651						  unsigned long val))
 652{
 653	int ret;
 654	u32 pval;
 655
 656	if (of_property_read_u32(client->dev.of_node, pname, &pval))
 657		return 0;
 658
 659	dev_dbg(&client->dev, "found %s (%d)\n", pname, pval);
 660	ret = (*psetter)(&client->dev, pval);
 661	if (ret)
 662		dev_err(&client->dev, "unable to set %s (%d)\n", pname, pval);
 663
 664	return ret;
 665}
 666
 667static int g762_of_prop_import(struct i2c_client *client)
 668{
 669	int ret;
 670
 671	if (!client->dev.of_node)
 672		return 0;
 673
 674	ret = g762_of_prop_import_one(client, "fan_gear_mode",
 675				      do_set_fan_gear_mode);
 676	if (ret)
 677		return ret;
 678
 679	ret = g762_of_prop_import_one(client, "pwm_polarity",
 680				      do_set_pwm_polarity);
 681	if (ret)
 682		return ret;
 683
 684	return g762_of_prop_import_one(client, "fan_startv",
 685				       do_set_fan_startv);
 686}
 687
 688#else
 689static int g762_of_prop_import(struct i2c_client *client)
 690{
 691	return 0;
 692}
 693
 694static int g762_of_clock_enable(struct i2c_client *client)
 695{
 696	return 0;
 697}
 698
 699static void g762_of_clock_disable(struct i2c_client *client) { }
 700#endif
 701
 702/*
 703 * Helper to import hardware characteristics from .dts file and push
 704 * those to the chip.
 705 */
 706
 707static int g762_pdata_prop_import(struct i2c_client *client)
 708{
 709	struct g762_platform_data *pdata = dev_get_platdata(&client->dev);
 710	int ret;
 711
 712	if (!pdata)
 713		return 0;
 714
 715	ret = do_set_fan_gear_mode(&client->dev, pdata->fan_gear_mode);
 716	if (ret)
 717		return ret;
 718
 719	ret = do_set_pwm_polarity(&client->dev, pdata->pwm_polarity);
 720	if (ret)
 721		return ret;
 722
 723	ret = do_set_fan_startv(&client->dev, pdata->fan_startv);
 724	if (ret)
 725		return ret;
 726
 727	return do_set_clk_freq(&client->dev, pdata->clk_freq);
 728}
 729
 730/*
 731 * sysfs attributes
 732 */
 733
 734/*
 735 * Read function for fan1_input sysfs file. Return current fan RPM value, or
 736 * 0 if fan is out of control.
 737 */
 738static ssize_t get_fan_rpm(struct device *dev, struct device_attribute *da,
 739			   char *buf)
 740{
 741	struct g762_data *data = g762_update_client(dev);
 742	unsigned int rpm = 0;
 743
 744	if (IS_ERR(data))
 745		return PTR_ERR(data);
 746
 747	mutex_lock(&data->update_lock);
 748	/* reverse logic: fan out of control reporting is enabled low */
 749	if (data->fan_sta & G762_REG_FAN_STA_OOC) {
 750		rpm = rpm_from_cnt(data->act_cnt, data->clk_freq,
 751				   G762_PULSE_FROM_REG(data->fan_cmd1),
 752				   G762_CLKDIV_FROM_REG(data->fan_cmd1),
 753				   G762_GEARMULT_FROM_REG(data->fan_cmd2));
 754	}
 755	mutex_unlock(&data->update_lock);
 756
 757	return sprintf(buf, "%u\n", rpm);
 758}
 759
 760/*
 761 * Read and write functions for pwm1_mode sysfs file. Get and set fan speed
 762 * control mode i.e. PWM (1) or DC (0).
 763 */
 764static ssize_t get_pwm_mode(struct device *dev, struct device_attribute *da,
 765			    char *buf)
 766{
 767	struct g762_data *data = g762_update_client(dev);
 768
 769	if (IS_ERR(data))
 770		return PTR_ERR(data);
 771
 772	return sprintf(buf, "%d\n",
 773		       !!(data->fan_cmd1 & G762_REG_FAN_CMD1_OUT_MODE));
 774}
 775
 776static ssize_t set_pwm_mode(struct device *dev, struct device_attribute *da,
 777			    const char *buf, size_t count)
 
 778{
 779	unsigned long val;
 780	int ret;
 781
 782	if (kstrtoul(buf, 10, &val))
 783		return -EINVAL;
 784
 785	ret = do_set_pwm_mode(dev, val);
 786	if (ret < 0)
 787		return ret;
 788
 789	return count;
 790}
 791
 792/*
 793 * Read and write functions for fan1_div sysfs file. Get and set fan
 794 * controller prescaler value
 795 */
 796static ssize_t get_fan_div(struct device *dev,
 797			   struct device_attribute *da, char *buf)
 798{
 799	struct g762_data *data = g762_update_client(dev);
 800
 801	if (IS_ERR(data))
 802		return PTR_ERR(data);
 803
 804	return sprintf(buf, "%d\n", G762_CLKDIV_FROM_REG(data->fan_cmd1));
 805}
 806
 807static ssize_t set_fan_div(struct device *dev,
 808			   struct device_attribute *da,
 809			   const char *buf, size_t count)
 810{
 811	unsigned long val;
 812	int ret;
 813
 814	if (kstrtoul(buf, 10, &val))
 815		return -EINVAL;
 816
 817	ret = do_set_fan_div(dev, val);
 818	if (ret < 0)
 819		return ret;
 820
 821	return count;
 822}
 823
 824/*
 825 * Read and write functions for fan1_pulses sysfs file. Get and set number
 826 * of tachometer pulses per fan revolution.
 827 */
 828static ssize_t get_fan_pulses(struct device *dev,
 829			      struct device_attribute *da, char *buf)
 830{
 831	struct g762_data *data = g762_update_client(dev);
 832
 833	if (IS_ERR(data))
 834		return PTR_ERR(data);
 835
 836	return sprintf(buf, "%d\n", G762_PULSE_FROM_REG(data->fan_cmd1));
 837}
 838
 839static ssize_t set_fan_pulses(struct device *dev,
 840			      struct device_attribute *da,
 841			      const char *buf, size_t count)
 842{
 843	unsigned long val;
 844	int ret;
 845
 846	if (kstrtoul(buf, 10, &val))
 847		return -EINVAL;
 848
 849	ret = do_set_fan_pulses(dev, val);
 850	if (ret < 0)
 851		return ret;
 852
 853	return count;
 854}
 855
 856/*
 857 * Read and write functions for pwm1_enable. Get and set fan speed control mode
 858 * (i.e. closed or open-loop).
 859 *
 860 * Following documentation about hwmon's sysfs interface, a pwm1_enable node
 861 * should accept followings:
 862 *
 863 *  0 : no fan speed control (i.e. fan at full speed)
 864 *  1 : manual fan speed control enabled (use pwm[1-*]) (open-loop)
 865 *  2+: automatic fan speed control enabled (use fan[1-*]_target) (closed-loop)
 866 *
 867 * but we do not accept 0 as this mode is not natively supported by the chip
 868 * and it is not emulated by g762 driver. -EINVAL is returned in this case.
 869 */
 870static ssize_t get_pwm_enable(struct device *dev,
 871			      struct device_attribute *da, char *buf)
 872{
 873	struct g762_data *data = g762_update_client(dev);
 874
 875	if (IS_ERR(data))
 876		return PTR_ERR(data);
 877
 878	return sprintf(buf, "%d\n",
 879		       (!!(data->fan_cmd1 & G762_REG_FAN_CMD1_FAN_MODE)) + 1);
 880}
 881
 882static ssize_t set_pwm_enable(struct device *dev,
 883			      struct device_attribute *da,
 884			      const char *buf, size_t count)
 885{
 886	unsigned long val;
 887	int ret;
 888
 889	if (kstrtoul(buf, 10, &val))
 890		return -EINVAL;
 891
 892	ret = do_set_pwm_enable(dev, val);
 893	if (ret < 0)
 894		return ret;
 895
 896	return count;
 897}
 898
 899/*
 900 * Read and write functions for pwm1 sysfs file. Get and set pwm value
 901 * (which affects fan speed) in open-loop mode. 0 stops the fan and 255
 902 * makes it run at full speed.
 903 */
 904static ssize_t get_pwm(struct device *dev, struct device_attribute *da,
 905		       char *buf)
 906{
 907	struct g762_data *data = g762_update_client(dev);
 908
 909	if (IS_ERR(data))
 910		return PTR_ERR(data);
 911
 912	return sprintf(buf, "%d\n", data->set_out);
 913}
 914
 915static ssize_t set_pwm(struct device *dev, struct device_attribute *da,
 916		       const char *buf, size_t count)
 917{
 918	unsigned long val;
 919	int ret;
 920
 921	if (kstrtoul(buf, 10, &val))
 922		return -EINVAL;
 923
 924	ret = do_set_pwm(dev, val);
 925	if (ret < 0)
 926		return ret;
 927
 928	return count;
 929}
 930
 931/*
 932 * Read and write function for fan1_target sysfs file. Get/set the fan speed in
 933 * closed-loop mode. Speed is given as a RPM value; then the chip will regulate
 934 * the fan speed using pulses from fan tachometer.
 935 *
 936 * Refer to rpm_from_cnt() implementation above to get info about count number
 937 * calculation.
 938 *
 939 * Also note that due to rounding errors it is possible that you don't read
 940 * back exactly the value you have set.
 941 */
 942static ssize_t get_fan_target(struct device *dev, struct device_attribute *da,
 943			      char *buf)
 944{
 945	struct g762_data *data = g762_update_client(dev);
 946	unsigned int rpm;
 947
 948	if (IS_ERR(data))
 949		return PTR_ERR(data);
 950
 951	mutex_lock(&data->update_lock);
 952	rpm = rpm_from_cnt(data->set_cnt, data->clk_freq,
 953			   G762_PULSE_FROM_REG(data->fan_cmd1),
 954			   G762_CLKDIV_FROM_REG(data->fan_cmd1),
 955			   G762_GEARMULT_FROM_REG(data->fan_cmd2));
 956	mutex_unlock(&data->update_lock);
 957
 958	return sprintf(buf, "%u\n", rpm);
 959}
 960
 961static ssize_t set_fan_target(struct device *dev, struct device_attribute *da,
 962			      const char *buf, size_t count)
 
 963{
 964	unsigned long val;
 965	int ret;
 966
 967	if (kstrtoul(buf, 10, &val))
 968		return -EINVAL;
 969
 970	ret = do_set_fan_target(dev, val);
 971	if (ret < 0)
 972		return ret;
 973
 974	return count;
 975}
 976
 977/* read function for fan1_fault sysfs file. */
 978static ssize_t get_fan_failure(struct device *dev, struct device_attribute *da,
 979			       char *buf)
 980{
 981	struct g762_data *data = g762_update_client(dev);
 982
 983	if (IS_ERR(data))
 984		return PTR_ERR(data);
 985
 986	return sprintf(buf, "%u\n", !!(data->fan_sta & G762_REG_FAN_STA_FAIL));
 987}
 988
 989/*
 990 * read function for fan1_alarm sysfs file. Note that OOC condition is
 991 * enabled low
 992 */
 993static ssize_t get_fan_ooc(struct device *dev, struct device_attribute *da,
 994			   char *buf)
 995{
 996	struct g762_data *data = g762_update_client(dev);
 997
 998	if (IS_ERR(data))
 999		return PTR_ERR(data);
1000
1001	return sprintf(buf, "%u\n", !(data->fan_sta & G762_REG_FAN_STA_OOC));
1002}
1003
1004static DEVICE_ATTR(pwm1, S_IWUSR | S_IRUGO, get_pwm, set_pwm);
1005static DEVICE_ATTR(pwm1_mode, S_IWUSR | S_IRUGO, get_pwm_mode, set_pwm_mode);
1006static DEVICE_ATTR(pwm1_enable, S_IWUSR | S_IRUGO,
1007		   get_pwm_enable, set_pwm_enable);
1008static DEVICE_ATTR(fan1_input, S_IRUGO, get_fan_rpm, NULL);
1009static DEVICE_ATTR(fan1_alarm, S_IRUGO, get_fan_ooc, NULL);
1010static DEVICE_ATTR(fan1_fault, S_IRUGO, get_fan_failure, NULL);
1011static DEVICE_ATTR(fan1_target, S_IWUSR | S_IRUGO,
1012		   get_fan_target, set_fan_target);
1013static DEVICE_ATTR(fan1_div, S_IWUSR | S_IRUGO, get_fan_div, set_fan_div);
1014static DEVICE_ATTR(fan1_pulses, S_IWUSR | S_IRUGO,
1015		   get_fan_pulses, set_fan_pulses);
1016
1017/* Driver data */
1018static struct attribute *g762_attrs[] = {
1019	&dev_attr_fan1_input.attr,
1020	&dev_attr_fan1_alarm.attr,
1021	&dev_attr_fan1_fault.attr,
1022	&dev_attr_fan1_target.attr,
1023	&dev_attr_fan1_div.attr,
1024	&dev_attr_fan1_pulses.attr,
1025	&dev_attr_pwm1.attr,
1026	&dev_attr_pwm1_mode.attr,
1027	&dev_attr_pwm1_enable.attr,
1028	NULL
1029};
1030
1031ATTRIBUTE_GROUPS(g762);
1032
1033/*
1034 * Enable both fan failure detection and fan out of control protection. The
1035 * function does not protect change/access to data structure; it must thus
1036 * only be called during initialization.
1037 */
1038static inline int g762_fan_init(struct device *dev)
1039{
1040	struct g762_data *data = g762_update_client(dev);
1041
1042	if (IS_ERR(data))
1043		return PTR_ERR(data);
1044
1045	data->fan_cmd1 |= G762_REG_FAN_CMD1_DET_FAN_FAIL;
1046	data->fan_cmd1 |= G762_REG_FAN_CMD1_DET_FAN_OOC;
1047	data->valid = false;
1048
1049	return i2c_smbus_write_byte_data(data->client, G762_REG_FAN_CMD1,
1050					 data->fan_cmd1);
1051}
1052
1053static int g762_probe(struct i2c_client *client, const struct i2c_device_id *id)
1054{
1055	struct device *dev = &client->dev;
 
1056	struct g762_data *data;
1057	int ret;
1058
1059	if (!i2c_check_functionality(client->adapter,
1060				     I2C_FUNC_SMBUS_BYTE_DATA))
1061		return -ENODEV;
1062
1063	data = devm_kzalloc(dev, sizeof(struct g762_data), GFP_KERNEL);
1064	if (!data)
1065		return -ENOMEM;
1066
1067	i2c_set_clientdata(client, data);
1068	data->client = client;
1069	mutex_init(&data->update_lock);
1070
1071	/* Enable fan failure detection and fan out of control protection */
1072	ret = g762_fan_init(dev);
1073	if (ret)
1074		return ret;
1075
1076	/* Get configuration via DT ... */
1077	ret = g762_of_clock_enable(client);
1078	if (ret)
1079		return ret;
1080	ret = g762_of_prop_import(client);
1081	if (ret)
1082		goto clock_dis;
1083	/* ... or platform_data */
1084	ret = g762_pdata_prop_import(client);
1085	if (ret)
1086		goto clock_dis;
1087
1088	data->hwmon_dev = hwmon_device_register_with_groups(dev, client->name,
1089							    data, g762_groups);
1090	if (IS_ERR(data->hwmon_dev)) {
1091		ret = PTR_ERR(data->hwmon_dev);
1092		goto clock_dis;
1093	}
1094
1095	return 0;
1096
1097 clock_dis:
1098	g762_of_clock_disable(client);
1099
1100	return ret;
1101}
1102
1103static int g762_remove(struct i2c_client *client)
1104{
1105	struct g762_data *data = i2c_get_clientdata(client);
1106
1107	hwmon_device_unregister(data->hwmon_dev);
1108	g762_of_clock_disable(client);
1109
1110	return 0;
1111}
1112
1113static struct i2c_driver g762_driver = {
1114	.driver = {
1115		.name = DRVNAME,
1116		.of_match_table = of_match_ptr(g762_dt_match),
1117	},
1118	.probe	  = g762_probe,
1119	.remove	  = g762_remove,
1120	.id_table = g762_id,
1121};
1122
1123module_i2c_driver(g762_driver);
1124
1125MODULE_AUTHOR("Arnaud EBALARD <arno@natisbad.org>");
1126MODULE_DESCRIPTION("GMT G762/G763 driver");
1127MODULE_LICENSE("GPL");