2 * Common code for Freescale MMA955x Intelligent Sensor Platform drivers
3 * Copyright (c) 2014, Intel Corporation.
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms and conditions of the GNU General Public License,
7 * version 2, as published by the Free Software Foundation.
9 * This program is distributed in the hope it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15 #include <linux/module.h>
16 #include <linux/i2c.h>
17 #include <linux/delay.h>
18 #include <linux/iio/iio.h>
19 #include <linux/pm_runtime.h>
20 #include "mma9551_core.h"
22 /* Command masks for mailbox write command */
23 #define MMA9551_CMD_READ_VERSION_INFO 0x00
24 #define MMA9551_CMD_READ_CONFIG 0x10
25 #define MMA9551_CMD_WRITE_CONFIG 0x20
26 #define MMA9551_CMD_READ_STATUS 0x30
28 /* Mailbox read command */
29 #define MMA9551_RESPONSE_COCO BIT(7)
31 /* Error-Status codes returned in mailbox read command */
32 #define MMA9551_MCI_ERROR_NONE 0x00
33 #define MMA9551_MCI_ERROR_PARAM 0x04
34 #define MMA9551_MCI_INVALID_COUNT 0x19
35 #define MMA9551_MCI_ERROR_COMMAND 0x1C
36 #define MMA9551_MCI_ERROR_INVALID_LENGTH 0x21
37 #define MMA9551_MCI_ERROR_FIFO_BUSY 0x22
38 #define MMA9551_MCI_ERROR_FIFO_ALLOCATED 0x23
39 #define MMA9551_MCI_ERROR_FIFO_OVERSIZE 0x24
41 /* GPIO Application */
42 #define MMA9551_GPIO_POL_MSB 0x08
43 #define MMA9551_GPIO_POL_LSB 0x09
45 /* Sleep/Wake application */
46 #define MMA9551_SLEEP_CFG 0x06
47 #define MMA9551_SLEEP_CFG_SNCEN BIT(0)
48 #define MMA9551_SLEEP_CFG_FLEEN BIT(1)
49 #define MMA9551_SLEEP_CFG_SCHEN BIT(2)
52 #define MMA9551_AFE_X_ACCEL_REG 0x00
53 #define MMA9551_AFE_Y_ACCEL_REG 0x02
54 #define MMA9551_AFE_Z_ACCEL_REG 0x04
56 /* Reset/Suspend/Clear application */
57 #define MMA9551_RSC_RESET 0x00
58 #define MMA9551_RSC_OFFSET(mask) (3 - (ffs(mask) - 1) / 8)
59 #define MMA9551_RSC_VAL(mask) (mask >> (((ffs(mask) - 1) / 8) * 8))
62 * A response is composed of:
63 * - control registers: MB0-3
64 * - data registers: MB4-31
66 * A request is composed of:
67 * - mbox to write to (always 0)
68 * - control registers: MB1-4
69 * - data registers: MB5-31
71 #define MMA9551_MAILBOX_CTRL_REGS 4
72 #define MMA9551_MAX_MAILBOX_DATA_REGS 28
73 #define MMA9551_MAILBOX_REGS 32
75 #define MMA9551_I2C_READ_RETRIES 5
76 #define MMA9551_I2C_READ_DELAY 50 /* us */
78 struct mma9551_mbox_request
{
79 u8 start_mbox
; /* Always 0. */
82 * See Section 5.3.1 of the MMA955xL Software Reference Manual.
84 * Bit 7: reserved, always 0
86 * Bits 3-0: upper bits of register offset
91 u8 buf
[MMA9551_MAX_MAILBOX_DATA_REGS
- 1];
94 struct mma9551_mbox_response
{
97 * See Section 5.3.3 of the MMA955xL Software Reference Manual.
100 * Bits 6-0: Error code.
105 u8 buf
[MMA9551_MAX_MAILBOX_DATA_REGS
];
108 struct mma9551_version_info
{
116 static int mma9551_transfer(struct i2c_client
*client
,
117 u8 app_id
, u8 command
, u16 offset
,
118 u8
*inbytes
, int num_inbytes
,
119 u8
*outbytes
, int num_outbytes
)
121 struct mma9551_mbox_request req
;
122 struct mma9551_mbox_response rsp
;
123 struct i2c_msg in
, out
;
124 u8 req_len
, err_code
;
127 if (offset
>= 1 << 12) {
128 dev_err(&client
->dev
, "register offset too large\n");
132 req_len
= 1 + MMA9551_MAILBOX_CTRL_REGS
+ num_inbytes
;
135 req
.cmd_off
= command
| (offset
>> 8);
136 req
.lower_off
= offset
;
138 if (command
== MMA9551_CMD_WRITE_CONFIG
)
139 req
.nbytes
= num_inbytes
;
141 req
.nbytes
= num_outbytes
;
143 memcpy(req
.buf
, inbytes
, num_inbytes
);
145 out
.addr
= client
->addr
;
148 out
.buf
= (u8
*)&req
;
150 ret
= i2c_transfer(client
->adapter
, &out
, 1);
152 dev_err(&client
->dev
, "i2c write failed\n");
156 retries
= MMA9551_I2C_READ_RETRIES
;
158 udelay(MMA9551_I2C_READ_DELAY
);
160 in
.addr
= client
->addr
;
162 in
.len
= sizeof(rsp
);
165 ret
= i2c_transfer(client
->adapter
, &in
, 1);
167 dev_err(&client
->dev
, "i2c read failed\n");
171 if (rsp
.coco_err
& MMA9551_RESPONSE_COCO
)
173 } while (--retries
> 0);
176 dev_err(&client
->dev
,
177 "timed out while waiting for command response\n");
181 if (rsp
.app_id
!= app_id
) {
182 dev_err(&client
->dev
,
183 "app_id mismatch in response got %02x expected %02x\n",
188 err_code
= rsp
.coco_err
& ~MMA9551_RESPONSE_COCO
;
189 if (err_code
!= MMA9551_MCI_ERROR_NONE
) {
190 dev_err(&client
->dev
, "read returned error %x\n", err_code
);
194 if (rsp
.nbytes
!= rsp
.req_bytes
) {
195 dev_err(&client
->dev
,
196 "output length mismatch got %d expected %d\n",
197 rsp
.nbytes
, rsp
.req_bytes
);
202 memcpy(outbytes
, rsp
.buf
, num_outbytes
);
208 * mma9551_read_config_byte() - read 1 configuration byte
209 * @client: I2C client
210 * @app_id: Application ID
211 * @reg: Application register
212 * @val: Pointer to store value read
214 * Read one configuration byte from the device using MMA955xL command format.
215 * Commands to the MMA955xL platform consist of a write followed
216 * by one or more reads.
218 * Locking note: This function must be called with the device lock held.
219 * Locking is not handled inside the function. Callers should ensure they
220 * serialize access to the HW.
222 * Returns: 0 on success, negative value on failure.
224 int mma9551_read_config_byte(struct i2c_client
*client
, u8 app_id
,
227 return mma9551_transfer(client
, app_id
, MMA9551_CMD_READ_CONFIG
,
228 reg
, NULL
, 0, val
, 1);
230 EXPORT_SYMBOL(mma9551_read_config_byte
);
233 * mma9551_write_config_byte() - write 1 configuration byte
234 * @client: I2C client
235 * @app_id: Application ID
236 * @reg: Application register
237 * @val: Value to write
239 * Write one configuration byte from the device using MMA955xL command format.
240 * Commands to the MMA955xL platform consist of a write followed by one or
243 * Locking note: This function must be called with the device lock held.
244 * Locking is not handled inside the function. Callers should ensure they
245 * serialize access to the HW.
247 * Returns: 0 on success, negative value on failure.
249 int mma9551_write_config_byte(struct i2c_client
*client
, u8 app_id
,
252 return mma9551_transfer(client
, app_id
, MMA9551_CMD_WRITE_CONFIG
, reg
,
255 EXPORT_SYMBOL(mma9551_write_config_byte
);
258 * mma9551_read_status_byte() - read 1 status byte
259 * @client: I2C client
260 * @app_id: Application ID
261 * @reg: Application register
262 * @val: Pointer to store value read
264 * Read one status byte from the device using MMA955xL command format.
265 * Commands to the MMA955xL platform consist of a write followed by one or
268 * Locking note: This function must be called with the device lock held.
269 * Locking is not handled inside the function. Callers should ensure they
270 * serialize access to the HW.
272 * Returns: 0 on success, negative value on failure.
274 int mma9551_read_status_byte(struct i2c_client
*client
, u8 app_id
,
277 return mma9551_transfer(client
, app_id
, MMA9551_CMD_READ_STATUS
,
278 reg
, NULL
, 0, val
, 1);
280 EXPORT_SYMBOL(mma9551_read_status_byte
);
283 * mma9551_read_config_word() - read 1 config word
284 * @client: I2C client
285 * @app_id: Application ID
286 * @reg: Application register
287 * @val: Pointer to store value read
289 * Read one configuration word from the device using MMA955xL command format.
290 * Commands to the MMA955xL platform consist of a write followed by one or
293 * Locking note: This function must be called with the device lock held.
294 * Locking is not handled inside the function. Callers should ensure they
295 * serialize access to the HW.
297 * Returns: 0 on success, negative value on failure.
299 int mma9551_read_config_word(struct i2c_client
*client
, u8 app_id
,
305 ret
= mma9551_transfer(client
, app_id
, MMA9551_CMD_READ_CONFIG
,
306 reg
, NULL
, 0, (u8
*)&v
, 2);
307 *val
= be16_to_cpu(v
);
311 EXPORT_SYMBOL(mma9551_read_config_word
);
314 * mma9551_write_config_word() - write 1 config word
315 * @client: I2C client
316 * @app_id: Application ID
317 * @reg: Application register
318 * @val: Value to write
320 * Write one configuration word from the device using MMA955xL command format.
321 * Commands to the MMA955xL platform consist of a write followed by one or
324 * Locking note: This function must be called with the device lock held.
325 * Locking is not handled inside the function. Callers should ensure they
326 * serialize access to the HW.
328 * Returns: 0 on success, negative value on failure.
330 int mma9551_write_config_word(struct i2c_client
*client
, u8 app_id
,
333 __be16 v
= cpu_to_be16(val
);
335 return mma9551_transfer(client
, app_id
, MMA9551_CMD_WRITE_CONFIG
, reg
,
336 (u8
*)&v
, 2, NULL
, 0);
338 EXPORT_SYMBOL(mma9551_write_config_word
);
341 * mma9551_read_status_word() - read 1 status word
342 * @client: I2C client
343 * @app_id: Application ID
344 * @reg: Application register
345 * @val: Pointer to store value read
347 * Read one status word from the device using MMA955xL command format.
348 * Commands to the MMA955xL platform consist of a write followed by one or
351 * Locking note: This function must be called with the device lock held.
352 * Locking is not handled inside the function. Callers should ensure they
353 * serialize access to the HW.
355 * Returns: 0 on success, negative value on failure.
357 int mma9551_read_status_word(struct i2c_client
*client
, u8 app_id
,
363 ret
= mma9551_transfer(client
, app_id
, MMA9551_CMD_READ_STATUS
,
364 reg
, NULL
, 0, (u8
*)&v
, 2);
365 *val
= be16_to_cpu(v
);
369 EXPORT_SYMBOL(mma9551_read_status_word
);
372 * mma9551_read_config_words() - read multiple config words
373 * @client: I2C client
374 * @app_id: Application ID
375 * @reg: Application register
376 * @len: Length of array to read (in words)
377 * @buf: Array of words to read
379 * Read multiple configuration registers (word-sized registers).
381 * Locking note: This function must be called with the device lock held.
382 * Locking is not handled inside the function. Callers should ensure they
383 * serialize access to the HW.
385 * Returns: 0 on success, negative value on failure.
387 int mma9551_read_config_words(struct i2c_client
*client
, u8 app_id
,
388 u16 reg
, u8 len
, u16
*buf
)
391 __be16 be_buf
[MMA9551_MAX_MAILBOX_DATA_REGS
/ 2];
393 if (len
> ARRAY_SIZE(be_buf
)) {
394 dev_err(&client
->dev
, "Invalid buffer size %d\n", len
);
398 ret
= mma9551_transfer(client
, app_id
, MMA9551_CMD_READ_CONFIG
,
399 reg
, NULL
, 0, (u8
*)be_buf
, len
* sizeof(u16
));
403 for (i
= 0; i
< len
; i
++)
404 buf
[i
] = be16_to_cpu(be_buf
[i
]);
408 EXPORT_SYMBOL(mma9551_read_config_words
);
411 * mma9551_read_status_words() - read multiple status words
412 * @client: I2C client
413 * @app_id: Application ID
414 * @reg: Application register
415 * @len: Length of array to read (in words)
416 * @buf: Array of words to read
418 * Read multiple status registers (word-sized registers).
420 * Locking note: This function must be called with the device lock held.
421 * Locking is not handled inside the function. Callers should ensure they
422 * serialize access to the HW.
424 * Returns: 0 on success, negative value on failure.
426 int mma9551_read_status_words(struct i2c_client
*client
, u8 app_id
,
427 u16 reg
, u8 len
, u16
*buf
)
430 __be16 be_buf
[MMA9551_MAX_MAILBOX_DATA_REGS
/ 2];
432 if (len
> ARRAY_SIZE(be_buf
)) {
433 dev_err(&client
->dev
, "Invalid buffer size %d\n", len
);
437 ret
= mma9551_transfer(client
, app_id
, MMA9551_CMD_READ_STATUS
,
438 reg
, NULL
, 0, (u8
*)be_buf
, len
* sizeof(u16
));
442 for (i
= 0; i
< len
; i
++)
443 buf
[i
] = be16_to_cpu(be_buf
[i
]);
447 EXPORT_SYMBOL(mma9551_read_status_words
);
450 * mma9551_write_config_words() - write multiple config words
451 * @client: I2C client
452 * @app_id: Application ID
453 * @reg: Application register
454 * @len: Length of array to write (in words)
455 * @buf: Array of words to write
457 * Write multiple configuration registers (word-sized registers).
459 * Locking note: This function must be called with the device lock held.
460 * Locking is not handled inside the function. Callers should ensure they
461 * serialize access to the HW.
463 * Returns: 0 on success, negative value on failure.
465 int mma9551_write_config_words(struct i2c_client
*client
, u8 app_id
,
466 u16 reg
, u8 len
, u16
*buf
)
469 __be16 be_buf
[(MMA9551_MAX_MAILBOX_DATA_REGS
- 1) / 2];
471 if (len
> ARRAY_SIZE(be_buf
)) {
472 dev_err(&client
->dev
, "Invalid buffer size %d\n", len
);
476 for (i
= 0; i
< len
; i
++)
477 be_buf
[i
] = cpu_to_be16(buf
[i
]);
479 return mma9551_transfer(client
, app_id
, MMA9551_CMD_WRITE_CONFIG
,
480 reg
, (u8
*)be_buf
, len
* sizeof(u16
), NULL
, 0);
482 EXPORT_SYMBOL(mma9551_write_config_words
);
485 * mma9551_update_config_bits() - update bits in register
486 * @client: I2C client
487 * @app_id: Application ID
488 * @reg: Application register
489 * @mask: Mask for the bits to update
490 * @val: Value of the bits to update
492 * Update bits in the given register using a bit mask.
494 * Locking note: This function must be called with the device lock held.
495 * Locking is not handled inside the function. Callers should ensure they
496 * serialize access to the HW.
498 * Returns: 0 on success, negative value on failure.
500 int mma9551_update_config_bits(struct i2c_client
*client
, u8 app_id
,
501 u16 reg
, u8 mask
, u8 val
)
506 ret
= mma9551_read_config_byte(client
, app_id
, reg
, &orig
);
516 return mma9551_write_config_byte(client
, app_id
, reg
, tmp
);
518 EXPORT_SYMBOL(mma9551_update_config_bits
);
521 * mma9551_gpio_config() - configure gpio
522 * @client: I2C client
523 * @pin: GPIO pin to configure
524 * @app_id: Application ID
525 * @bitnum: Bit number of status register being assigned to the GPIO pin.
526 * @polarity: The polarity parameter is described in section 6.2.2, page 66,
527 * of the Software Reference Manual. Basically, polarity=0 means
528 * the interrupt line has the same value as the selected bit,
529 * while polarity=1 means the line is inverted.
531 * Assign a bit from an application’s status register to a specific GPIO pin.
533 * Locking note: This function must be called with the device lock held.
534 * Locking is not handled inside the function. Callers should ensure they
535 * serialize access to the HW.
537 * Returns: 0 on success, negative value on failure.
539 int mma9551_gpio_config(struct i2c_client
*client
, enum mma9551_gpio_pin pin
,
540 u8 app_id
, u8 bitnum
, int polarity
)
542 u8 reg
, pol_mask
, pol_val
;
545 if (pin
> mma9551_gpio_max
) {
546 dev_err(&client
->dev
, "bad GPIO pin\n");
551 * Pin 6 is configured by regs 0x00 and 0x01, pin 7 by 0x02 and
556 ret
= mma9551_write_config_byte(client
, MMA9551_APPID_GPIO
,
559 dev_err(&client
->dev
, "error setting GPIO app_id\n");
563 ret
= mma9551_write_config_byte(client
, MMA9551_APPID_GPIO
,
566 dev_err(&client
->dev
, "error setting GPIO bit number\n");
572 reg
= MMA9551_GPIO_POL_LSB
;
576 reg
= MMA9551_GPIO_POL_LSB
;
580 reg
= MMA9551_GPIO_POL_MSB
;
584 reg
= MMA9551_GPIO_POL_MSB
;
588 pol_val
= polarity
? pol_mask
: 0;
590 ret
= mma9551_update_config_bits(client
, MMA9551_APPID_GPIO
, reg
,
593 dev_err(&client
->dev
, "error setting GPIO polarity\n");
597 EXPORT_SYMBOL(mma9551_gpio_config
);
600 * mma9551_read_version() - read device version information
601 * @client: I2C client
603 * Read version information and print device id and firmware version.
605 * Locking note: This function must be called with the device lock held.
606 * Locking is not handled inside the function. Callers should ensure they
607 * serialize access to the HW.
609 * Returns: 0 on success, negative value on failure.
611 int mma9551_read_version(struct i2c_client
*client
)
613 struct mma9551_version_info info
;
616 ret
= mma9551_transfer(client
, MMA9551_APPID_VERSION
, 0x00, 0x00,
617 NULL
, 0, (u8
*)&info
, sizeof(info
));
621 dev_info(&client
->dev
, "device ID 0x%x, firmware version %02x.%02x\n",
622 be32_to_cpu(info
.device_id
), info
.fw_version
[0],
627 EXPORT_SYMBOL(mma9551_read_version
);
630 * mma9551_set_device_state() - sets HW power mode
631 * @client: I2C client
632 * @enable: Use true to power on device, false to cause the device
635 * Set power on/off for device using the Sleep/Wake Application.
636 * When enable is true, power on chip and enable doze mode.
637 * When enable is false, enter sleep mode (device remains in the
638 * lowest-power mode).
640 * Locking note: This function must be called with the device lock held.
641 * Locking is not handled inside the function. Callers should ensure they
642 * serialize access to the HW.
644 * Returns: 0 on success, negative value on failure.
646 int mma9551_set_device_state(struct i2c_client
*client
, bool enable
)
648 return mma9551_update_config_bits(client
, MMA9551_APPID_SLEEP_WAKE
,
650 MMA9551_SLEEP_CFG_SNCEN
|
651 MMA9551_SLEEP_CFG_FLEEN
|
652 MMA9551_SLEEP_CFG_SCHEN
,
653 enable
? MMA9551_SLEEP_CFG_SCHEN
|
654 MMA9551_SLEEP_CFG_FLEEN
:
655 MMA9551_SLEEP_CFG_SNCEN
);
657 EXPORT_SYMBOL(mma9551_set_device_state
);
660 * mma9551_set_power_state() - sets runtime PM state
661 * @client: I2C client
662 * @on: Use true to power on device, false to power off
664 * Resume or suspend the device using Runtime PM.
665 * The device will suspend after the autosuspend delay.
667 * Returns: 0 on success, negative value on failure.
669 int mma9551_set_power_state(struct i2c_client
*client
, bool on
)
675 ret
= pm_runtime_get_sync(&client
->dev
);
677 pm_runtime_mark_last_busy(&client
->dev
);
678 ret
= pm_runtime_put_autosuspend(&client
->dev
);
682 dev_err(&client
->dev
,
683 "failed to change power state to %d\n", on
);
685 pm_runtime_put_noidle(&client
->dev
);
693 EXPORT_SYMBOL(mma9551_set_power_state
);
696 * mma9551_sleep() - sleep
697 * @freq: Application frequency
699 * Firmware applications run at a certain frequency on the
700 * device. Sleep for one application cycle to make sure the
701 * application had time to run once and initialize set values.
703 void mma9551_sleep(int freq
)
705 int sleep_val
= 1000 / freq
;
708 usleep_range(sleep_val
* 1000, 20000);
710 msleep_interruptible(sleep_val
);
712 EXPORT_SYMBOL(mma9551_sleep
);
715 * mma9551_read_accel_chan() - read accelerometer channel
716 * @client: I2C client
718 * @val: Pointer to the accelerometer value read
721 * Read accelerometer value for the specified channel.
723 * Locking note: This function must be called with the device lock held.
724 * Locking is not handled inside the function. Callers should ensure they
725 * serialize access to the HW.
727 * Returns: IIO_VAL_INT on success, negative value on failure.
729 int mma9551_read_accel_chan(struct i2c_client
*client
,
730 const struct iio_chan_spec
*chan
,
737 switch (chan
->channel2
) {
739 reg_addr
= MMA9551_AFE_X_ACCEL_REG
;
742 reg_addr
= MMA9551_AFE_Y_ACCEL_REG
;
745 reg_addr
= MMA9551_AFE_Z_ACCEL_REG
;
751 ret
= mma9551_set_power_state(client
, true);
755 ret
= mma9551_read_status_word(client
, MMA9551_APPID_AFE
,
756 reg_addr
, &raw_accel
);
765 mma9551_set_power_state(client
, false);
768 EXPORT_SYMBOL(mma9551_read_accel_chan
);
771 * mma9551_read_accel_scale() - read accelerometer scale
772 * @val: Pointer to the accelerometer scale (int value)
773 * @val2: Pointer to the accelerometer scale (micro value)
775 * Read accelerometer scale.
777 * Returns: IIO_VAL_INT_PLUS_MICRO.
779 int mma9551_read_accel_scale(int *val
, int *val2
)
784 return IIO_VAL_INT_PLUS_MICRO
;
786 EXPORT_SYMBOL(mma9551_read_accel_scale
);
789 * mma9551_app_reset() - reset application
790 * @client: I2C client
791 * @app_mask: Application to reset
793 * Reset the given application (using the Reset/Suspend/Clear
794 * Control Application)
796 * Returns: 0 on success, negative value on failure.
798 int mma9551_app_reset(struct i2c_client
*client
, u32 app_mask
)
800 return mma9551_write_config_byte(client
, MMA9551_APPID_RSC
,
802 MMA9551_RSC_OFFSET(app_mask
),
803 MMA9551_RSC_VAL(app_mask
));
805 EXPORT_SYMBOL(mma9551_app_reset
);
807 MODULE_AUTHOR("Irina Tirdea <irina.tirdea@intel.com>");
808 MODULE_AUTHOR("Vlad Dogaru <vlad.dogaru@intel.com>");
809 MODULE_LICENSE("GPL v2");
810 MODULE_DESCRIPTION("MMA955xL sensors core");