blob: bd017b57c47f8af4ff1558cedaa8589a5f0ce9ff [file] [log] [blame]
Maxime Riparda2ed00d2012-12-07 12:30:38 -08001/*
Masanari Iidaa895d572013-04-09 02:06:50 +09002 * Driver for the Solomon SSD1307 OLED controller
Maxime Riparda2ed00d2012-12-07 12:30:38 -08003 *
4 * Copyright 2012 Free Electrons
5 *
6 * Licensed under the GPLv2 or later.
7 */
8
Thomas Niederprüm6ed5e2d2015-03-31 20:27:15 +02009#include <linux/backlight.h>
Olliver Schinagl48846ec2015-09-08 21:19:50 +020010#include <linux/delay.h>
Maxime Riparda2ed00d2012-12-07 12:30:38 -080011#include <linux/fb.h>
Arnd Bergmann580203f2017-02-20 13:51:07 +010012#include <linux/gpio/consumer.h>
Olliver Schinagl48846ec2015-09-08 21:19:50 +020013#include <linux/i2c.h>
14#include <linux/kernel.h>
15#include <linux/module.h>
Maxime Riparda2ed00d2012-12-07 12:30:38 -080016#include <linux/of_device.h>
17#include <linux/of_gpio.h>
18#include <linux/pwm.h>
Olliver Schinagl48846ec2015-09-08 21:19:50 +020019#include <linux/uaccess.h>
Tomi Valkeinenba14301e2017-02-08 16:43:59 +010020#include <linux/regulator/consumer.h>
Maxime Riparda2ed00d2012-12-07 12:30:38 -080021
Maxime Riparda2ed00d2012-12-07 12:30:38 -080022#define SSD1307FB_DATA 0x40
23#define SSD1307FB_COMMAND 0x80
24
Maxime Ripard301bc062013-04-22 12:02:25 +020025#define SSD1307FB_SET_ADDRESS_MODE 0x20
26#define SSD1307FB_SET_ADDRESS_MODE_HORIZONTAL (0x00)
27#define SSD1307FB_SET_ADDRESS_MODE_VERTICAL (0x01)
28#define SSD1307FB_SET_ADDRESS_MODE_PAGE (0x02)
29#define SSD1307FB_SET_COL_RANGE 0x21
30#define SSD1307FB_SET_PAGE_RANGE 0x22
Maxime Riparda2ed00d2012-12-07 12:30:38 -080031#define SSD1307FB_CONTRAST 0x81
Maxime Ripardbbc79082013-04-22 11:55:54 +020032#define SSD1307FB_CHARGE_PUMP 0x8d
Maxime Riparda2ed00d2012-12-07 12:30:38 -080033#define SSD1307FB_SEG_REMAP_ON 0xa1
34#define SSD1307FB_DISPLAY_OFF 0xae
Maxime Ripardbbc79082013-04-22 11:55:54 +020035#define SSD1307FB_SET_MULTIPLEX_RATIO 0xa8
Maxime Riparda2ed00d2012-12-07 12:30:38 -080036#define SSD1307FB_DISPLAY_ON 0xaf
37#define SSD1307FB_START_PAGE_ADDRESS 0xb0
Maxime Ripardbbc79082013-04-22 11:55:54 +020038#define SSD1307FB_SET_DISPLAY_OFFSET 0xd3
39#define SSD1307FB_SET_CLOCK_FREQ 0xd5
40#define SSD1307FB_SET_PRECHARGE_PERIOD 0xd9
41#define SSD1307FB_SET_COM_PINS_CONFIG 0xda
42#define SSD1307FB_SET_VCOMH 0xdb
43
Thomas Niederprüm6ed5e2d2015-03-31 20:27:15 +020044#define MAX_CONTRAST 255
45
Thomas Niederprüm3277e0b2015-03-31 20:27:13 +020046#define REFRESHRATE 1
47
48static u_int refreshrate = REFRESHRATE;
49module_param(refreshrate, uint, 0);
50
Maxime Ripardbbc79082013-04-22 11:55:54 +020051struct ssd1307fb_par;
52
Thomas Niederprümc89eacf2015-03-31 20:27:10 +020053struct ssd1307fb_deviceinfo {
54 u32 default_vcomh;
55 u32 default_dclk_div;
56 u32 default_dclk_frq;
57 int need_pwm;
58 int need_chargepump;
Maxime Ripardbbc79082013-04-22 11:55:54 +020059};
Maxime Riparda2ed00d2012-12-07 12:30:38 -080060
61struct ssd1307fb_par {
Thomas Niederprümc89eacf2015-03-31 20:27:10 +020062 u32 com_invdir;
63 u32 com_lrremap;
64 u32 com_offset;
65 u32 com_seq;
66 u32 contrast;
67 u32 dclk_div;
68 u32 dclk_frq;
LABBE Corentin60169c32016-08-16 11:27:17 +020069 const struct ssd1307fb_deviceinfo *device_info;
Maxime Riparda2ed00d2012-12-07 12:30:38 -080070 struct i2c_client *client;
Maxime Ripardbbc79082013-04-22 11:55:54 +020071 u32 height;
Maxime Riparda2ed00d2012-12-07 12:30:38 -080072 struct fb_info *info;
Maxime Ripardbbc79082013-04-22 11:55:54 +020073 u32 page_offset;
Thomas Niederprümc89eacf2015-03-31 20:27:10 +020074 u32 prechargep1;
75 u32 prechargep2;
Maxime Riparda2ed00d2012-12-07 12:30:38 -080076 struct pwm_device *pwm;
77 u32 pwm_period;
Jyri Sarha72db3332017-02-08 16:43:59 +010078 struct gpio_desc *reset;
Tomi Valkeinenba14301e2017-02-08 16:43:59 +010079 struct regulator *vbat_reg;
Thomas Niederprümc89eacf2015-03-31 20:27:10 +020080 u32 seg_remap;
81 u32 vcomh;
Maxime Ripardbbc79082013-04-22 11:55:54 +020082 u32 width;
Maxime Riparda2ed00d2012-12-07 12:30:38 -080083};
84
Maxime Ripard9f7714d2013-04-22 12:02:23 +020085struct ssd1307fb_array {
86 u8 type;
87 u8 data[0];
88};
89
Julia Lawallca9384c2016-09-11 17:17:20 +020090static const struct fb_fix_screeninfo ssd1307fb_fix = {
Maxime Riparda2ed00d2012-12-07 12:30:38 -080091 .id = "Solomon SSD1307",
92 .type = FB_TYPE_PACKED_PIXELS,
93 .visual = FB_VISUAL_MONO10,
94 .xpanstep = 0,
95 .ypanstep = 0,
96 .ywrapstep = 0,
Maxime Riparda2ed00d2012-12-07 12:30:38 -080097 .accel = FB_ACCEL_NONE,
98};
99
Julia Lawallca9384c2016-09-11 17:17:20 +0200100static const struct fb_var_screeninfo ssd1307fb_var = {
Maxime Riparda2ed00d2012-12-07 12:30:38 -0800101 .bits_per_pixel = 1,
102};
103
Maxime Ripard9f7714d2013-04-22 12:02:23 +0200104static struct ssd1307fb_array *ssd1307fb_alloc_array(u32 len, u8 type)
Maxime Riparda2ed00d2012-12-07 12:30:38 -0800105{
Maxime Ripard9f7714d2013-04-22 12:02:23 +0200106 struct ssd1307fb_array *array;
Maxime Riparda2ed00d2012-12-07 12:30:38 -0800107
Maxime Ripard9f7714d2013-04-22 12:02:23 +0200108 array = kzalloc(sizeof(struct ssd1307fb_array) + len, GFP_KERNEL);
109 if (!array)
110 return NULL;
Maxime Riparda2ed00d2012-12-07 12:30:38 -0800111
Maxime Ripard9f7714d2013-04-22 12:02:23 +0200112 array->type = type;
Maxime Riparda2ed00d2012-12-07 12:30:38 -0800113
Maxime Ripard9f7714d2013-04-22 12:02:23 +0200114 return array;
Maxime Riparda2ed00d2012-12-07 12:30:38 -0800115}
116
Maxime Ripard9f7714d2013-04-22 12:02:23 +0200117static int ssd1307fb_write_array(struct i2c_client *client,
118 struct ssd1307fb_array *array, u32 len)
Maxime Riparda2ed00d2012-12-07 12:30:38 -0800119{
Maxime Ripard9f7714d2013-04-22 12:02:23 +0200120 int ret;
121
122 len += sizeof(struct ssd1307fb_array);
123
124 ret = i2c_master_send(client, (u8 *)array, len);
125 if (ret != len) {
126 dev_err(&client->dev, "Couldn't send I2C command.\n");
127 return ret;
128 }
129
130 return 0;
Maxime Riparda2ed00d2012-12-07 12:30:38 -0800131}
132
133static inline int ssd1307fb_write_cmd(struct i2c_client *client, u8 cmd)
134{
Maxime Ripard9f7714d2013-04-22 12:02:23 +0200135 struct ssd1307fb_array *array;
136 int ret;
Maxime Riparda2ed00d2012-12-07 12:30:38 -0800137
Maxime Ripard9f7714d2013-04-22 12:02:23 +0200138 array = ssd1307fb_alloc_array(1, SSD1307FB_COMMAND);
139 if (!array)
140 return -ENOMEM;
141
142 array->data[0] = cmd;
143
144 ret = ssd1307fb_write_array(client, array, 1);
145 kfree(array);
146
147 return ret;
Maxime Riparda2ed00d2012-12-07 12:30:38 -0800148}
149
Maxime Riparda2ed00d2012-12-07 12:30:38 -0800150static void ssd1307fb_update_display(struct ssd1307fb_par *par)
151{
Maxime Ripard301bc062013-04-22 12:02:25 +0200152 struct ssd1307fb_array *array;
Maxime Riparda2ed00d2012-12-07 12:30:38 -0800153 u8 *vmem = par->info->screen_base;
154 int i, j, k;
155
Maxime Ripard301bc062013-04-22 12:02:25 +0200156 array = ssd1307fb_alloc_array(par->width * par->height / 8,
157 SSD1307FB_DATA);
158 if (!array)
159 return;
160
Maxime Riparda2ed00d2012-12-07 12:30:38 -0800161 /*
162 * The screen is divided in pages, each having a height of 8
163 * pixels, and the width of the screen. When sending a byte of
164 * data to the controller, it gives the 8 bits for the current
165 * column. I.e, the first byte are the 8 bits of the first
166 * column, then the 8 bits for the second column, etc.
167 *
168 *
169 * Representation of the screen, assuming it is 5 bits
170 * wide. Each letter-number combination is a bit that controls
171 * one pixel.
172 *
173 * A0 A1 A2 A3 A4
174 * B0 B1 B2 B3 B4
175 * C0 C1 C2 C3 C4
176 * D0 D1 D2 D3 D4
177 * E0 E1 E2 E3 E4
178 * F0 F1 F2 F3 F4
179 * G0 G1 G2 G3 G4
180 * H0 H1 H2 H3 H4
181 *
182 * If you want to update this screen, you need to send 5 bytes:
183 * (1) A0 B0 C0 D0 E0 F0 G0 H0
184 * (2) A1 B1 C1 D1 E1 F1 G1 H1
185 * (3) A2 B2 C2 D2 E2 F2 G2 H2
186 * (4) A3 B3 C3 D3 E3 F3 G3 H3
187 * (5) A4 B4 C4 D4 E4 F4 G4 H4
188 */
189
Maxime Ripardbbc79082013-04-22 11:55:54 +0200190 for (i = 0; i < (par->height / 8); i++) {
Maxime Ripardbbc79082013-04-22 11:55:54 +0200191 for (j = 0; j < par->width; j++) {
Maxime Ripard301bc062013-04-22 12:02:25 +0200192 u32 array_idx = i * par->width + j;
193 array->data[array_idx] = 0;
Maxime Riparda2ed00d2012-12-07 12:30:38 -0800194 for (k = 0; k < 8; k++) {
Maxime Ripardbbc79082013-04-22 11:55:54 +0200195 u32 page_length = par->width * i;
196 u32 index = page_length + (par->width * k + j) / 8;
Maxime Riparda2ed00d2012-12-07 12:30:38 -0800197 u8 byte = *(vmem + index);
Maxime Ripard552f0cc2013-01-11 14:31:43 -0800198 u8 bit = byte & (1 << (j % 8));
199 bit = bit >> (j % 8);
Maxime Ripard301bc062013-04-22 12:02:25 +0200200 array->data[array_idx] |= bit << k;
Maxime Riparda2ed00d2012-12-07 12:30:38 -0800201 }
Maxime Riparda2ed00d2012-12-07 12:30:38 -0800202 }
203 }
Maxime Ripard301bc062013-04-22 12:02:25 +0200204
205 ssd1307fb_write_array(par->client, array, par->width * par->height / 8);
206 kfree(array);
Maxime Riparda2ed00d2012-12-07 12:30:38 -0800207}
208
209
210static ssize_t ssd1307fb_write(struct fb_info *info, const char __user *buf,
211 size_t count, loff_t *ppos)
212{
213 struct ssd1307fb_par *par = info->par;
214 unsigned long total_size;
215 unsigned long p = *ppos;
216 u8 __iomem *dst;
217
218 total_size = info->fix.smem_len;
219
220 if (p > total_size)
221 return -EINVAL;
222
223 if (count + p > total_size)
224 count = total_size - p;
225
226 if (!count)
227 return -EINVAL;
228
229 dst = (void __force *) (info->screen_base + p);
230
231 if (copy_from_user(dst, buf, count))
232 return -EFAULT;
233
234 ssd1307fb_update_display(par);
235
236 *ppos += count;
237
238 return count;
239}
240
Thomas Niederprüm550e7682015-03-31 20:27:16 +0200241static int ssd1307fb_blank(int blank_mode, struct fb_info *info)
242{
243 struct ssd1307fb_par *par = info->par;
244
245 if (blank_mode != FB_BLANK_UNBLANK)
246 return ssd1307fb_write_cmd(par->client, SSD1307FB_DISPLAY_OFF);
247 else
248 return ssd1307fb_write_cmd(par->client, SSD1307FB_DISPLAY_ON);
249}
250
Maxime Riparda2ed00d2012-12-07 12:30:38 -0800251static void ssd1307fb_fillrect(struct fb_info *info, const struct fb_fillrect *rect)
252{
253 struct ssd1307fb_par *par = info->par;
254 sys_fillrect(info, rect);
255 ssd1307fb_update_display(par);
256}
257
258static void ssd1307fb_copyarea(struct fb_info *info, const struct fb_copyarea *area)
259{
260 struct ssd1307fb_par *par = info->par;
261 sys_copyarea(info, area);
262 ssd1307fb_update_display(par);
263}
264
265static void ssd1307fb_imageblit(struct fb_info *info, const struct fb_image *image)
266{
267 struct ssd1307fb_par *par = info->par;
268 sys_imageblit(info, image);
269 ssd1307fb_update_display(par);
270}
271
272static struct fb_ops ssd1307fb_ops = {
273 .owner = THIS_MODULE,
274 .fb_read = fb_sys_read,
275 .fb_write = ssd1307fb_write,
Thomas Niederprüm550e7682015-03-31 20:27:16 +0200276 .fb_blank = ssd1307fb_blank,
Maxime Riparda2ed00d2012-12-07 12:30:38 -0800277 .fb_fillrect = ssd1307fb_fillrect,
278 .fb_copyarea = ssd1307fb_copyarea,
279 .fb_imageblit = ssd1307fb_imageblit,
280};
281
282static void ssd1307fb_deferred_io(struct fb_info *info,
283 struct list_head *pagelist)
284{
285 ssd1307fb_update_display(info->par);
286}
287
Thomas Niederprümc89eacf2015-03-31 20:27:10 +0200288static int ssd1307fb_init(struct ssd1307fb_par *par)
Maxime Ripardbbc79082013-04-22 11:55:54 +0200289{
290 int ret;
Thomas Niederprümc89eacf2015-03-31 20:27:10 +0200291 u32 precharge, dclk, com_invdir, compins;
Boris Brezillon717c18f2016-04-14 21:17:28 +0200292 struct pwm_args pargs;
Maxime Ripardbbc79082013-04-22 11:55:54 +0200293
Thomas Niederprümc89eacf2015-03-31 20:27:10 +0200294 if (par->device_info->need_pwm) {
295 par->pwm = pwm_get(&par->client->dev, NULL);
296 if (IS_ERR(par->pwm)) {
297 dev_err(&par->client->dev, "Could not get PWM from device tree!\n");
298 return PTR_ERR(par->pwm);
299 }
Maxime Ripardbbc79082013-04-22 11:55:54 +0200300
Boris Brezillon717c18f2016-04-14 21:17:28 +0200301 /*
302 * FIXME: pwm_apply_args() should be removed when switching to
303 * the atomic PWM API.
304 */
305 pwm_apply_args(par->pwm);
306
307 pwm_get_args(par->pwm, &pargs);
308
309 par->pwm_period = pargs.period;
Thomas Niederprümc89eacf2015-03-31 20:27:10 +0200310 /* Enable the PWM */
311 pwm_config(par->pwm, par->pwm_period / 2, par->pwm_period);
312 pwm_enable(par->pwm);
Maxime Ripardbbc79082013-04-22 11:55:54 +0200313
Thomas Niederprümc89eacf2015-03-31 20:27:10 +0200314 dev_dbg(&par->client->dev, "Using PWM%d with a %dns period.\n",
315 par->pwm->pwm, par->pwm_period);
316 };
Maxime Ripardbbc79082013-04-22 11:55:54 +0200317
318 /* Set initial contrast */
319 ret = ssd1307fb_write_cmd(par->client, SSD1307FB_CONTRAST);
Prabhakar Lad5b72ae92015-01-15 19:05:37 +0000320 if (ret < 0)
321 return ret;
322
Thomas Niederprümc89eacf2015-03-31 20:27:10 +0200323 ret = ssd1307fb_write_cmd(par->client, par->contrast);
Maxime Ripardbbc79082013-04-22 11:55:54 +0200324 if (ret < 0)
325 return ret;
326
327 /* Set segment re-map */
Thomas Niederprümc89eacf2015-03-31 20:27:10 +0200328 if (par->seg_remap) {
329 ret = ssd1307fb_write_cmd(par->client, SSD1307FB_SEG_REMAP_ON);
330 if (ret < 0)
331 return ret;
332 };
333
334 /* Set COM direction */
335 com_invdir = 0xc0 | (par->com_invdir & 0x1) << 3;
336 ret = ssd1307fb_write_cmd(par->client, com_invdir);
Maxime Ripardbbc79082013-04-22 11:55:54 +0200337 if (ret < 0)
338 return ret;
339
340 /* Set multiplex ratio value */
341 ret = ssd1307fb_write_cmd(par->client, SSD1307FB_SET_MULTIPLEX_RATIO);
Prabhakar Lad5b72ae92015-01-15 19:05:37 +0000342 if (ret < 0)
343 return ret;
344
345 ret = ssd1307fb_write_cmd(par->client, par->height - 1);
Maxime Ripardbbc79082013-04-22 11:55:54 +0200346 if (ret < 0)
347 return ret;
348
349 /* set display offset value */
350 ret = ssd1307fb_write_cmd(par->client, SSD1307FB_SET_DISPLAY_OFFSET);
Prabhakar Lad5b72ae92015-01-15 19:05:37 +0000351 if (ret < 0)
352 return ret;
353
Thomas Niederprümc89eacf2015-03-31 20:27:10 +0200354 ret = ssd1307fb_write_cmd(par->client, par->com_offset);
Maxime Ripardbbc79082013-04-22 11:55:54 +0200355 if (ret < 0)
356 return ret;
357
358 /* Set clock frequency */
359 ret = ssd1307fb_write_cmd(par->client, SSD1307FB_SET_CLOCK_FREQ);
Prabhakar Lad5b72ae92015-01-15 19:05:37 +0000360 if (ret < 0)
361 return ret;
362
Thomas Niederprümc89eacf2015-03-31 20:27:10 +0200363 dclk = ((par->dclk_div - 1) & 0xf) | (par->dclk_frq & 0xf) << 4;
364 ret = ssd1307fb_write_cmd(par->client, dclk);
Maxime Ripardbbc79082013-04-22 11:55:54 +0200365 if (ret < 0)
366 return ret;
367
368 /* Set precharge period in number of ticks from the internal clock */
369 ret = ssd1307fb_write_cmd(par->client, SSD1307FB_SET_PRECHARGE_PERIOD);
Prabhakar Lad5b72ae92015-01-15 19:05:37 +0000370 if (ret < 0)
371 return ret;
372
Thomas Niederprümc89eacf2015-03-31 20:27:10 +0200373 precharge = (par->prechargep1 & 0xf) | (par->prechargep2 & 0xf) << 4;
374 ret = ssd1307fb_write_cmd(par->client, precharge);
Maxime Ripardbbc79082013-04-22 11:55:54 +0200375 if (ret < 0)
376 return ret;
377
378 /* Set COM pins configuration */
379 ret = ssd1307fb_write_cmd(par->client, SSD1307FB_SET_COM_PINS_CONFIG);
Prabhakar Lad5b72ae92015-01-15 19:05:37 +0000380 if (ret < 0)
381 return ret;
382
Thomas Niederprüm5e479322015-05-25 21:29:21 +0200383 compins = 0x02 | !(par->com_seq & 0x1) << 4
Thomas Niederprümc89eacf2015-03-31 20:27:10 +0200384 | (par->com_lrremap & 0x1) << 5;
385 ret = ssd1307fb_write_cmd(par->client, compins);
Maxime Ripardbbc79082013-04-22 11:55:54 +0200386 if (ret < 0)
387 return ret;
388
389 /* Set VCOMH */
390 ret = ssd1307fb_write_cmd(par->client, SSD1307FB_SET_VCOMH);
Prabhakar Lad5b72ae92015-01-15 19:05:37 +0000391 if (ret < 0)
392 return ret;
393
Thomas Niederprümc89eacf2015-03-31 20:27:10 +0200394 ret = ssd1307fb_write_cmd(par->client, par->vcomh);
Maxime Ripardbbc79082013-04-22 11:55:54 +0200395 if (ret < 0)
396 return ret;
397
398 /* Turn on the DC-DC Charge Pump */
399 ret = ssd1307fb_write_cmd(par->client, SSD1307FB_CHARGE_PUMP);
Prabhakar Lad5b72ae92015-01-15 19:05:37 +0000400 if (ret < 0)
401 return ret;
402
Thomas Niederprümc89eacf2015-03-31 20:27:10 +0200403 ret = ssd1307fb_write_cmd(par->client,
Julian Scheel80403b22016-03-24 22:14:23 +0100404 BIT(4) | (par->device_info->need_chargepump ? BIT(2) : 0));
Maxime Ripardbbc79082013-04-22 11:55:54 +0200405 if (ret < 0)
406 return ret;
407
Maxime Ripard301bc062013-04-22 12:02:25 +0200408 /* Switch to horizontal addressing mode */
409 ret = ssd1307fb_write_cmd(par->client, SSD1307FB_SET_ADDRESS_MODE);
Prabhakar Lad5b72ae92015-01-15 19:05:37 +0000410 if (ret < 0)
411 return ret;
412
413 ret = ssd1307fb_write_cmd(par->client,
414 SSD1307FB_SET_ADDRESS_MODE_HORIZONTAL);
Maxime Ripard301bc062013-04-22 12:02:25 +0200415 if (ret < 0)
416 return ret;
417
Thomas Niederprümc89eacf2015-03-31 20:27:10 +0200418 /* Set column range */
Maxime Ripard301bc062013-04-22 12:02:25 +0200419 ret = ssd1307fb_write_cmd(par->client, SSD1307FB_SET_COL_RANGE);
Prabhakar Lad5b72ae92015-01-15 19:05:37 +0000420 if (ret < 0)
421 return ret;
422
423 ret = ssd1307fb_write_cmd(par->client, 0x0);
424 if (ret < 0)
425 return ret;
426
427 ret = ssd1307fb_write_cmd(par->client, par->width - 1);
Maxime Ripard301bc062013-04-22 12:02:25 +0200428 if (ret < 0)
429 return ret;
430
Thomas Niederprümc89eacf2015-03-31 20:27:10 +0200431 /* Set page range */
Maxime Ripard301bc062013-04-22 12:02:25 +0200432 ret = ssd1307fb_write_cmd(par->client, SSD1307FB_SET_PAGE_RANGE);
Prabhakar Lad5b72ae92015-01-15 19:05:37 +0000433 if (ret < 0)
434 return ret;
435
436 ret = ssd1307fb_write_cmd(par->client, 0x0);
437 if (ret < 0)
438 return ret;
439
440 ret = ssd1307fb_write_cmd(par->client,
441 par->page_offset + (par->height / 8) - 1);
Maxime Ripard301bc062013-04-22 12:02:25 +0200442 if (ret < 0)
443 return ret;
444
Tomi Valkeinen6e376822017-02-08 16:44:00 +0100445 /* Clear the screen */
446 ssd1307fb_update_display(par);
Jyri Sarhafdde1a812017-02-08 16:43:59 +0100447
Maxime Ripardbbc79082013-04-22 11:55:54 +0200448 /* Turn on the display */
449 ret = ssd1307fb_write_cmd(par->client, SSD1307FB_DISPLAY_ON);
450 if (ret < 0)
451 return ret;
452
453 return 0;
454}
455
Thomas Niederprüm6ed5e2d2015-03-31 20:27:15 +0200456static int ssd1307fb_update_bl(struct backlight_device *bdev)
457{
458 struct ssd1307fb_par *par = bl_get_data(bdev);
459 int ret;
460 int brightness = bdev->props.brightness;
461
462 par->contrast = brightness;
463
464 ret = ssd1307fb_write_cmd(par->client, SSD1307FB_CONTRAST);
465 if (ret < 0)
466 return ret;
467 ret = ssd1307fb_write_cmd(par->client, par->contrast);
468 if (ret < 0)
469 return ret;
470 return 0;
471}
472
473static int ssd1307fb_get_brightness(struct backlight_device *bdev)
474{
475 struct ssd1307fb_par *par = bl_get_data(bdev);
476
477 return par->contrast;
478}
479
480static int ssd1307fb_check_fb(struct backlight_device *bdev,
481 struct fb_info *info)
482{
483 return (info->bl_dev == bdev);
484}
485
486static const struct backlight_ops ssd1307fb_bl_ops = {
487 .options = BL_CORE_SUSPENDRESUME,
488 .update_status = ssd1307fb_update_bl,
489 .get_brightness = ssd1307fb_get_brightness,
490 .check_fb = ssd1307fb_check_fb,
491};
492
Thomas Niederprüm5f2d36b2015-03-31 20:27:12 +0200493static struct ssd1307fb_deviceinfo ssd1307fb_ssd1305_deviceinfo = {
494 .default_vcomh = 0x34,
495 .default_dclk_div = 1,
496 .default_dclk_frq = 7,
497};
498
Thomas Niederprümc89eacf2015-03-31 20:27:10 +0200499static struct ssd1307fb_deviceinfo ssd1307fb_ssd1306_deviceinfo = {
500 .default_vcomh = 0x20,
501 .default_dclk_div = 1,
502 .default_dclk_frq = 8,
503 .need_chargepump = 1,
504};
505
506static struct ssd1307fb_deviceinfo ssd1307fb_ssd1307_deviceinfo = {
507 .default_vcomh = 0x20,
508 .default_dclk_div = 2,
509 .default_dclk_frq = 12,
510 .need_pwm = 1,
Maxime Ripardbbc79082013-04-22 11:55:54 +0200511};
512
Olliver Schinagl3ac58d52015-09-08 21:19:51 +0200513static struct ssd1307fb_deviceinfo ssd1307fb_ssd1309_deviceinfo = {
514 .default_vcomh = 0x34,
515 .default_dclk_div = 1,
516 .default_dclk_frq = 10,
517};
518
Maxime Ripardbbc79082013-04-22 11:55:54 +0200519static const struct of_device_id ssd1307fb_of_match[] = {
520 {
Thomas Niederprüm5f2d36b2015-03-31 20:27:12 +0200521 .compatible = "solomon,ssd1305fb-i2c",
522 .data = (void *)&ssd1307fb_ssd1305_deviceinfo,
523 },
524 {
Maxime Ripardbbc79082013-04-22 11:55:54 +0200525 .compatible = "solomon,ssd1306fb-i2c",
Thomas Niederprümc89eacf2015-03-31 20:27:10 +0200526 .data = (void *)&ssd1307fb_ssd1306_deviceinfo,
Maxime Ripardbbc79082013-04-22 11:55:54 +0200527 },
528 {
529 .compatible = "solomon,ssd1307fb-i2c",
Thomas Niederprümc89eacf2015-03-31 20:27:10 +0200530 .data = (void *)&ssd1307fb_ssd1307_deviceinfo,
Maxime Ripardbbc79082013-04-22 11:55:54 +0200531 },
Olliver Schinagl3ac58d52015-09-08 21:19:51 +0200532 {
533 .compatible = "solomon,ssd1309fb-i2c",
534 .data = (void *)&ssd1307fb_ssd1309_deviceinfo,
535 },
Maxime Ripardbbc79082013-04-22 11:55:54 +0200536 {},
537};
538MODULE_DEVICE_TABLE(of, ssd1307fb_of_match);
539
Greg Kroah-Hartman48c68c42012-12-21 13:07:39 -0800540static int ssd1307fb_probe(struct i2c_client *client,
541 const struct i2c_device_id *id)
Maxime Riparda2ed00d2012-12-07 12:30:38 -0800542{
Thomas Niederprüm6ed5e2d2015-03-31 20:27:15 +0200543 struct backlight_device *bl;
544 char bl_name[12];
Maxime Riparda2ed00d2012-12-07 12:30:38 -0800545 struct fb_info *info;
Maxime Ripardbbc79082013-04-22 11:55:54 +0200546 struct device_node *node = client->dev.of_node;
Thomas Niederprüm3277e0b2015-03-31 20:27:13 +0200547 struct fb_deferred_io *ssd1307fb_defio;
Maxime Ripardbbc79082013-04-22 11:55:54 +0200548 u32 vmem_size;
Maxime Riparda2ed00d2012-12-07 12:30:38 -0800549 struct ssd1307fb_par *par;
550 u8 *vmem;
551 int ret;
552
Maxime Ripardbbc79082013-04-22 11:55:54 +0200553 if (!node) {
Maxime Riparda2ed00d2012-12-07 12:30:38 -0800554 dev_err(&client->dev, "No device tree data found!\n");
555 return -EINVAL;
556 }
557
558 info = framebuffer_alloc(sizeof(struct ssd1307fb_par), &client->dev);
559 if (!info) {
560 dev_err(&client->dev, "Couldn't allocate framebuffer.\n");
561 return -ENOMEM;
562 }
563
Maxime Ripardbbc79082013-04-22 11:55:54 +0200564 par = info->par;
565 par->info = info;
566 par->client = client;
567
LABBE Corentind8ed9e82016-08-16 11:27:18 +0200568 par->device_info = of_device_get_match_data(&client->dev);
Maxime Ripardbbc79082013-04-22 11:55:54 +0200569
Jyri Sarhafdde1a812017-02-08 16:43:59 +0100570 par->reset = devm_gpiod_get_optional(&client->dev, "reset",
571 GPIOD_OUT_LOW);
Jyri Sarha72db3332017-02-08 16:43:59 +0100572 if (IS_ERR(par->reset)) {
573 dev_err(&client->dev, "failed to get reset gpio: %ld\n",
574 PTR_ERR(par->reset));
575 ret = PTR_ERR(par->reset);
Maxime Ripardbbc79082013-04-22 11:55:54 +0200576 goto fb_alloc_error;
577 }
578
Tomi Valkeinenba14301e2017-02-08 16:43:59 +0100579 par->vbat_reg = devm_regulator_get_optional(&client->dev, "vbat");
580 if (IS_ERR(par->vbat_reg)) {
581 dev_err(&client->dev, "failed to get VBAT regulator: %ld\n",
582 PTR_ERR(par->vbat_reg));
583 ret = PTR_ERR(par->vbat_reg);
584 goto fb_alloc_error;
585 }
586
Maxime Ripardbbc79082013-04-22 11:55:54 +0200587 if (of_property_read_u32(node, "solomon,width", &par->width))
588 par->width = 96;
589
590 if (of_property_read_u32(node, "solomon,height", &par->height))
Lad, Prabhakar9561def2015-01-08 08:17:58 +0000591 par->height = 16;
Maxime Ripardbbc79082013-04-22 11:55:54 +0200592
593 if (of_property_read_u32(node, "solomon,page-offset", &par->page_offset))
594 par->page_offset = 1;
595
Thomas Niederprümc89eacf2015-03-31 20:27:10 +0200596 if (of_property_read_u32(node, "solomon,com-offset", &par->com_offset))
597 par->com_offset = 0;
598
599 if (of_property_read_u32(node, "solomon,prechargep1", &par->prechargep1))
600 par->prechargep1 = 2;
601
602 if (of_property_read_u32(node, "solomon,prechargep2", &par->prechargep2))
603 par->prechargep2 = 2;
604
605 par->seg_remap = !of_property_read_bool(node, "solomon,segment-no-remap");
606 par->com_seq = of_property_read_bool(node, "solomon,com-seq");
607 par->com_lrremap = of_property_read_bool(node, "solomon,com-lrremap");
608 par->com_invdir = of_property_read_bool(node, "solomon,com-invdir");
609
610 par->contrast = 127;
611 par->vcomh = par->device_info->default_vcomh;
612
613 /* Setup display timing */
614 par->dclk_div = par->device_info->default_dclk_div;
615 par->dclk_frq = par->device_info->default_dclk_frq;
616
Maxime Ripardbbc79082013-04-22 11:55:54 +0200617 vmem_size = par->width * par->height / 8;
618
Thomas Niederprümfacd94b2015-03-31 20:27:08 +0200619 vmem = (void *)__get_free_pages(GFP_KERNEL | __GFP_ZERO,
620 get_order(vmem_size));
Maxime Riparda2ed00d2012-12-07 12:30:38 -0800621 if (!vmem) {
622 dev_err(&client->dev, "Couldn't allocate graphical memory.\n");
623 ret = -ENOMEM;
624 goto fb_alloc_error;
625 }
626
Thomas Niederprüm3277e0b2015-03-31 20:27:13 +0200627 ssd1307fb_defio = devm_kzalloc(&client->dev, sizeof(struct fb_deferred_io), GFP_KERNEL);
628 if (!ssd1307fb_defio) {
629 dev_err(&client->dev, "Couldn't allocate deferred io.\n");
630 ret = -ENOMEM;
631 goto fb_alloc_error;
632 }
633
634 ssd1307fb_defio->delay = HZ / refreshrate;
635 ssd1307fb_defio->deferred_io = ssd1307fb_deferred_io;
636
Maxime Riparda2ed00d2012-12-07 12:30:38 -0800637 info->fbops = &ssd1307fb_ops;
638 info->fix = ssd1307fb_fix;
Maxime Ripardbbc79082013-04-22 11:55:54 +0200639 info->fix.line_length = par->width / 8;
Thomas Niederprüm3277e0b2015-03-31 20:27:13 +0200640 info->fbdefio = ssd1307fb_defio;
Maxime Riparda2ed00d2012-12-07 12:30:38 -0800641
642 info->var = ssd1307fb_var;
Maxime Ripardbbc79082013-04-22 11:55:54 +0200643 info->var.xres = par->width;
644 info->var.xres_virtual = par->width;
645 info->var.yres = par->height;
646 info->var.yres_virtual = par->height;
647
Maxime Riparda2ed00d2012-12-07 12:30:38 -0800648 info->var.red.length = 1;
649 info->var.red.offset = 0;
650 info->var.green.length = 1;
651 info->var.green.offset = 0;
652 info->var.blue.length = 1;
653 info->var.blue.offset = 0;
654
655 info->screen_base = (u8 __force __iomem *)vmem;
Thomas Niederprüm258c0ea2015-03-31 20:27:07 +0200656 info->fix.smem_start = __pa(vmem);
Maxime Riparda2ed00d2012-12-07 12:30:38 -0800657 info->fix.smem_len = vmem_size;
658
659 fb_deferred_io_init(info);
660
Maxime Riparda2ed00d2012-12-07 12:30:38 -0800661 i2c_set_clientdata(client, info);
662
Jyri Sarhafdde1a812017-02-08 16:43:59 +0100663 if (par->reset) {
664 /* Reset the screen */
665 gpiod_set_value(par->reset, 0);
666 udelay(4);
667 gpiod_set_value(par->reset, 1);
668 udelay(4);
669 }
Maxime Riparda2ed00d2012-12-07 12:30:38 -0800670
Tomi Valkeinenba14301e2017-02-08 16:43:59 +0100671 ret = regulator_enable(par->vbat_reg);
672 if (ret) {
673 dev_err(&client->dev, "failed to enable VBAT: %d\n", ret);
674 goto reset_oled_error;
675 }
676
Thomas Niederprümc89eacf2015-03-31 20:27:10 +0200677 ret = ssd1307fb_init(par);
678 if (ret)
Tomi Valkeinenba14301e2017-02-08 16:43:59 +0100679 goto regulator_enable_error;
Maxime Riparda2ed00d2012-12-07 12:30:38 -0800680
Maxime Ripardbbc79082013-04-22 11:55:54 +0200681 ret = register_framebuffer(info);
682 if (ret) {
683 dev_err(&client->dev, "Couldn't register the framebuffer\n");
684 goto panel_init_error;
Maxime Riparda2ed00d2012-12-07 12:30:38 -0800685 }
686
Thomas Niederprüm6ed5e2d2015-03-31 20:27:15 +0200687 snprintf(bl_name, sizeof(bl_name), "ssd1307fb%d", info->node);
688 bl = backlight_device_register(bl_name, &client->dev, par,
689 &ssd1307fb_bl_ops, NULL);
Thomas Niederprüm6ed5e2d2015-03-31 20:27:15 +0200690 if (IS_ERR(bl)) {
Julia Lawallc4e67742015-08-23 02:11:15 +0200691 ret = PTR_ERR(bl);
692 dev_err(&client->dev, "unable to register backlight device: %d\n",
693 ret);
Thomas Niederprüm6ed5e2d2015-03-31 20:27:15 +0200694 goto bl_init_error;
695 }
Dan Carpenterc2b00022015-05-23 20:32:35 +0300696
697 bl->props.brightness = par->contrast;
698 bl->props.max_brightness = MAX_CONTRAST;
699 info->bl_dev = bl;
700
Maxime Riparda2ed00d2012-12-07 12:30:38 -0800701 dev_info(&client->dev, "fb%d: %s framebuffer device registered, using %d bytes of video memory\n", info->node, info->fix.id, vmem_size);
702
703 return 0;
704
Thomas Niederprüm6ed5e2d2015-03-31 20:27:15 +0200705bl_init_error:
706 unregister_framebuffer(info);
Maxime Ripardbbc79082013-04-22 11:55:54 +0200707panel_init_error:
Thomas Niederprümc89eacf2015-03-31 20:27:10 +0200708 if (par->device_info->need_pwm) {
709 pwm_disable(par->pwm);
710 pwm_put(par->pwm);
711 };
Tomi Valkeinenba14301e2017-02-08 16:43:59 +0100712regulator_enable_error:
713 regulator_disable(par->vbat_reg);
Maxime Riparda2ed00d2012-12-07 12:30:38 -0800714reset_oled_error:
715 fb_deferred_io_cleanup(info);
716fb_alloc_error:
717 framebuffer_release(info);
718 return ret;
719}
720
Greg Kroah-Hartman48c68c42012-12-21 13:07:39 -0800721static int ssd1307fb_remove(struct i2c_client *client)
Maxime Riparda2ed00d2012-12-07 12:30:38 -0800722{
723 struct fb_info *info = i2c_get_clientdata(client);
724 struct ssd1307fb_par *par = info->par;
725
Thomas Niederprüm13bad592015-03-31 20:27:14 +0200726 ssd1307fb_write_cmd(par->client, SSD1307FB_DISPLAY_OFF);
727
Thomas Niederprüm6ed5e2d2015-03-31 20:27:15 +0200728 backlight_device_unregister(info->bl_dev);
729
Maxime Riparda2ed00d2012-12-07 12:30:38 -0800730 unregister_framebuffer(info);
Thomas Niederprümc89eacf2015-03-31 20:27:10 +0200731 if (par->device_info->need_pwm) {
732 pwm_disable(par->pwm);
733 pwm_put(par->pwm);
734 };
Maxime Riparda2ed00d2012-12-07 12:30:38 -0800735 fb_deferred_io_cleanup(info);
Thomas Niederprümfacd94b2015-03-31 20:27:08 +0200736 __free_pages(__va(info->fix.smem_start), get_order(info->fix.smem_len));
Maxime Riparda2ed00d2012-12-07 12:30:38 -0800737 framebuffer_release(info);
738
739 return 0;
740}
741
742static const struct i2c_device_id ssd1307fb_i2c_id[] = {
Thomas Niederprüm5f2d36b2015-03-31 20:27:12 +0200743 { "ssd1305fb", 0 },
Maxime Ripardbbc79082013-04-22 11:55:54 +0200744 { "ssd1306fb", 0 },
Maxime Riparda2ed00d2012-12-07 12:30:38 -0800745 { "ssd1307fb", 0 },
Olliver Schinagl3ac58d52015-09-08 21:19:51 +0200746 { "ssd1309fb", 0 },
Maxime Riparda2ed00d2012-12-07 12:30:38 -0800747 { }
748};
749MODULE_DEVICE_TABLE(i2c, ssd1307fb_i2c_id);
750
Maxime Riparda2ed00d2012-12-07 12:30:38 -0800751static struct i2c_driver ssd1307fb_driver = {
752 .probe = ssd1307fb_probe,
Greg Kroah-Hartman48c68c42012-12-21 13:07:39 -0800753 .remove = ssd1307fb_remove,
Maxime Riparda2ed00d2012-12-07 12:30:38 -0800754 .id_table = ssd1307fb_i2c_id,
755 .driver = {
756 .name = "ssd1307fb",
Sachin Kamatd71f8cd2013-09-30 14:15:31 +0530757 .of_match_table = ssd1307fb_of_match,
Maxime Riparda2ed00d2012-12-07 12:30:38 -0800758 },
759};
760
761module_i2c_driver(ssd1307fb_driver);
762
Masanari Iidaa895d572013-04-09 02:06:50 +0900763MODULE_DESCRIPTION("FB driver for the Solomon SSD1307 OLED controller");
Maxime Riparda2ed00d2012-12-07 12:30:38 -0800764MODULE_AUTHOR("Maxime Ripard <maxime.ripard@free-electrons.com>");
765MODULE_LICENSE("GPL");