Re: [PATCH] backlight: Add backlight driver for Bachmann's ot200

[Christian Gmeiner]

2012/1/25 Andres Salomon <dilinger@xxxxxxxxxx>:
> On Wed, 25 Jan 2012 00:30:31 +0100
> Christian Gmeiner <christian.gmeiner@xxxxxxxxx> wrote:
>
>> From 27574197e9f8425c6aeadffef199c8b7eb969233 Mon Sep 17 00:00:00 2001
>> From: Christian Gmeiner <christian.gmeiner@xxxxxxxxx>
>> Date: Fri, 13 Jan 2012 15:31:01 +0100
>> Subject: [PATCH] backlight: Add backlight driver for Bachmann's ot200
>>
>> Add backlight driver for Bachmann's ot200 visualisation device. The
>> driver uses MFGPT 7 of CS5535 silicon to regulate the backlight.
>>
>> Signed-off-by: Christian Gmeiner <christian.gmeiner@xxxxxxxxx>
>> ---
>> Âdrivers/video/backlight/Kconfig  Â|  Â9 ++
>> Âdrivers/video/backlight/Makefile  |  Â2 +-
>> Âdrivers/video/backlight/ot200_bl.c | Â167
>> ++++++++++++++++++++++++++++++++++++ 3 files changed, 177
>> insertions(+), 1 deletions(-) create mode 100644
>> drivers/video/backlight/ot200_bl.c
>>
>> diff --git a/drivers/video/backlight/Kconfig
>> b/drivers/video/backlight/Kconfig index 278aeaa..ab02544 100644
>> --- a/drivers/video/backlight/Kconfig
>> +++ b/drivers/video/backlight/Kconfig
>> @@ -342,6 +342,15 @@ config BACKLIGHT_AAT2870
>> Â Â Â Â If you have a AnalogicTech AAT2870 say Y to enable the
>> Â Â Â Â backlight driver.
>>
>> +config BACKLIGHT_OT200
>> + Â Â tristate "Backlight Driver for Bachmann's OT200"
>
> This is purely personal preference, but the possessive apostrophe for
> the manufacturer's device seems weird.
>

okay
>
>> + Â Â depends on BACKLIGHT_CLASS_DEVICE
>> + Â Â select MFD_CS5535
>> + Â Â select CS5535_MFGPT
>
> This is modular; is there any reason to select these instead of simply
> depending upon them? ÂA strict dependency would be preferrable.
>
> Also, CS5535_MFGPT already depends upon MFD_CS5535, so you can probably
> drop that.
>

good argument - will change it
>
>> + Â Â help
>> + Â Â Â To compile this driver as a module, choose M here: the
>> module will be
>> + Â Â Â called ot200_bl.
>> +
>> Âendif # BACKLIGHT_CLASS_DEVICE
>>
>> Âendif # BACKLIGHT_LCD_SUPPORT
>> diff --git a/drivers/video/backlight/Makefile
>> b/drivers/video/backlight/Makefile index fdd1fc4..4f07d3f 100644
>> --- a/drivers/video/backlight/Makefile
>> +++ b/drivers/video/backlight/Makefile
>> @@ -39,4 +39,4 @@ obj-$(CONFIG_BACKLIGHT_ADP8870) Â Â +=
>> adp8870_bl.o obj-$(CONFIG_BACKLIGHT_88PM860X) += 88pm860x_bl.o
>> Âobj-$(CONFIG_BACKLIGHT_PCF50633) Â Â += pcf50633-backlight.o
>> Âobj-$(CONFIG_BACKLIGHT_AAT2870) += aat2870_bl.o
>> -
>> +obj-$(CONFIG_BACKLIGHT_OT200) += ot200_bl.o
>> diff --git a/drivers/video/backlight/ot200_bl.c
>> b/drivers/video/backlight/ot200_bl.c new file mode 100644
>> index 0000000..d8e8ba1
>> --- /dev/null
>> +++ b/drivers/video/backlight/ot200_bl.c
>> @@ -0,0 +1,167 @@
>> +/*
>> + * Copyright (C) 2012 Bachmann electronic GmbH
>> + * Â Christian Gmeiner <christian.gmeiner@xxxxxxxxx>
>> + *
>> + * Backlight driver for Bachmann's ot200.
>> + *
>> + * This program is free software; you can redistribute it and/or
>> modify it
>> + * under the terms of the GNU General Public License version 2 as
>> published by
>> + * the Free Software Foundation.
>> + */
>> +
>> +#include <linux/module.h>
>> +#include <linux/fb.h>
>> +#include <linux/backlight.h>
>> +#include <linux/gpio.h>
>> +#include <linux/cs5535.h>
>> +
>> +static struct cs5535_mfgpt_timer *pwm_timer;
>> +static const Âu8 DIM_TABLE[101] = {0, 0, 1, 1, 1, 1, 1, 1, 1, 2, 2,
>
> Please don't use CAPS_VARIABLES unless it's a macro.
>

okay
>
>> 2, 2, 2, 2,
>> + Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â2, 2, 2, 2, 3, 3, 3, 3, 3, 3, 3,
>> 4, 4, 4, 4,
>> + Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â4, 5, 5, 5, 5, 6, 6, 6, 7, 7, 7,
>> 8, 8, 9, 9,
>> + Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â10, 10, 11, 11, 12, 12, 13, 14,
>> 15, 15, 16,
>> + Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â17, 18, 19, 20, 21, 22, 23, 24,
>> 26, 27, 28,
>> + Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â30, 31, 33, 35, 37, 39, 41, 43,
>> 45, 47, 50,
>> + Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â53, 55, 58, 61, 65, 68, 72, 75,
>> 79, 84, 88,
>> + Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â93, 97, 103, 108, 114, 120, 126,
>> 133, 140,
>> + Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â147, 155, 163};
>
> Also, please describe what this table means, or is for.
>

will do in v2

>
>> +
>> +struct ot200_backlight_data {
>> + Â Â int current_brightness;
>> +};
>> +
>> +#define GPIO_DIMM Â Â27
>> +
>> +static int ot200_backlight_update_status(struct backlight_device *bl)
>> +{
>> + Â Â struct ot200_backlight_data *data = bl_get_data(bl);
>> + Â Â int brightness = bl->props.brightness;
>
> Please use an unsigned here.

okay
>
>> +
>> + Â Â if (bl->props.state & BL_CORE_FBBLANK)
>> + Â Â Â Â Â Â brightness = 0;
>> +
>> + Â Â /* enable or disable PWM timer */
>> + Â Â if (brightness == 0)
>> + Â Â Â Â Â Â cs5535_mfgpt_write(pwm_timer, MFGPT_REG_SETUP, 0);
>
> Do you want to disable the timer when the driver/backlight device is
> unloaded, or will that turn off the backlight?
>

I never thought about this use case, but I think it would be the best to
turn brightness of the display to 100%.
>
>> + Â Â else if (brightness != 0 && data->current_brightness == 0) {
>> + Â Â Â Â Â Â cs5535_mfgpt_write(pwm_timer, MFGPT_REG_COUNTER, 0);
>> + Â Â Â Â Â Â cs5535_mfgpt_write(pwm_timer, MFGPT_REG_SETUP,
>> 0x8281);
>> + Â Â }
>> +
>> + Â Â /* apply new brightness value */
>> + Â Â cs5535_mfgpt_write(pwm_timer, MFGPT_REG_CMP1,
>> + Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 163 - DIM_TABLE[brightness]);
>> + Â Â data->current_brightness = brightness;
>> +
>> + Â Â return 0;
>> +}
>> +
>> +static int ot200_backlight_get_brightness(struct backlight_device
>> *bl) +{
>> + Â Â struct ot200_backlight_data *data = bl_get_data(bl);
>> + Â Â return data->current_brightness;
>> +}
>> +
>> +static const struct backlight_ops ot200_backlight_ops = {
>> + Â Â .update_status Â= ot200_backlight_update_status,
>> + Â Â .get_brightness = ot200_backlight_get_brightness,
>> +};
>> +
>> +static int ot200_backlight_probe(struct platform_device *pdev)
>> +{
>> + Â Â struct backlight_device *bl;
>> + Â Â struct ot200_backlight_data *data;
>> + Â Â struct backlight_properties props;
>> + Â Â int retval = 0;
>> +
>> + Â Â /* request gpio */
>> + Â Â if (gpio_request(GPIO_DIMM, "ot200 backlight dimmer") < 0) {
>> + Â Â Â Â Â Â printk(KERN_ERR "ot200 backlight: failed to request
>> GPIO %d\n",
>
> I notice you're using dev_err below, but printk(KERN_ERR here. ÂAny
> reason for that? ÂMy preference would be dev_err here.

upps
>
>> + Â Â Â Â Â Â Â Â Â Â Â Â Â Â GPIO_DIMM);
>> + Â Â Â Â Â Â return -ENODEV;
>> + Â Â }
>> +
>> + Â Â /* request timer */
>> + Â Â pwm_timer = cs5535_mfgpt_alloc_timer(7, MFGPT_DOMAIN_ANY);
>> + Â Â if (!pwm_timer) {
>> + Â Â Â Â Â Â printk(KERN_ERR "ot200 backlight: MFGPT 7 not
>> available\n");
>
> Ditto.
>
>> + Â Â Â Â Â Â retval = -ENODEV;
>> + Â Â Â Â Â Â goto error_mfgpt_alloc;
>> + Â Â }
>> +
>> + Â Â data = kzalloc(sizeof(*data), GFP_KERNEL);
>> + Â Â if (data == NULL) {
>
> Please use "if (!data) {" here.
>

okay
>> + Â Â Â Â Â Â retval = -ENOMEM;
>> + Â Â Â Â Â Â goto error_kzalloc;
>> + Â Â }
>> +
>> + Â Â /* setup gpio */
>> + Â Â cs5535_gpio_set(GPIO_DIMM, GPIO_OUTPUT_ENABLE);
>> + Â Â cs5535_gpio_set(GPIO_DIMM, GPIO_OUTPUT_AUX1);
>> +
>> + Â Â /* setup timer */
>> + Â Â cs5535_mfgpt_write(pwm_timer, MFGPT_REG_CMP1, 0);
>> + Â Â cs5535_mfgpt_write(pwm_timer, MFGPT_REG_CMP2, 0xa3);
>> + Â Â cs5535_mfgpt_write(pwm_timer, MFGPT_REG_SETUP, 0x8281);
>
> Can you please document this? ÂThis is a backlight driver; what
> are you using timers for? ÂWhat is the setup here meant to do? ÂI'd
> like to see an english description for people so that a glance over
> this doesn't require checking the data sheet, and so that we can verify
> that the code matches the desired effect.
>

I also will have a look into the datasheet, as the driver is port of a vxworks
driver, but I will remove the magic numbers.
>
>> +
>> + Â Â data->current_brightness = 100;
>> + Â Â props.max_brightness = 100;
>> + Â Â props.brightness = 100;
>> + Â Â props.type = BACKLIGHT_RAW;
>> +
>> + Â Â bl = backlight_device_register("ipc", &pdev->dev, data,
>
> What's ipc?

Industrial PC :) I need a name of the backlight device that is equal on
all Bachmann visualisation devices. In the near future I will add post
some patches for an other visualisation device. The goal is to have
it equal on visualisation device - makes the userspace much simpler.

>
>> + Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â &ot200_backlight_ops,
>> &props);
>> + Â Â if (IS_ERR(bl)) {
>> + Â Â Â Â Â Â dev_err(&pdev->dev, "failed to register
>> backlight\n");
>> + Â Â Â Â Â Â retval = PTR_ERR(bl);
>> + Â Â Â Â Â Â goto error_backlight_device_register;
>> + Â Â }
>> +
>> + Â Â platform_set_drvdata(pdev, bl);
>> +
>> + Â Â return 0;
>> +
>> +error_backlight_device_register:
>> + Â Â kfree(data);
>> +error_kzalloc:
>> + Â Â cs5535_mfgpt_free_timer(pwm_timer);
>> +error_mfgpt_alloc:
>> + Â Â gpio_free(GPIO_DIMM);
>> + Â Â return retval;
>> +}
>> +
>> +static int ot200_backlight_remove(struct platform_device *pdev)
>> +{
>> + Â Â struct backlight_device *bl = platform_get_drvdata(pdev);
>> + Â Â struct ot200_backlight_data *data = bl_get_data(bl);
>> +
>> + Â Â backlight_device_unregister(bl);
>> + Â Â kfree(data);
>
> What about freeing the gpio? ÂAlso, the timer? ÂI know the timer code
> doesn't allow you to reuse the timer once it's been set up, but at
> least you could avoid leaking the pwm_timer memory.
>

good chatch

>
>> + Â Â return 0;
>> +}
>> +
>> +static struct platform_driver ot200_backlight_driver = {
>
> This can probably use __devinitdata.

okay
>
>> +   .driver     = {
>> +       .name  = "ot200-backlight",
>> + Â Â Â Â Â Â .owner Â= THIS_MODULE,
>> + Â Â },
>> +   .probe     Â= ot200_backlight_probe,
>> +   .remove     = ot200_backlight_remove,
>> +};
>> +
>> +static int __init ot200_backlight_init(void)
>> +{
>> + Â Â return platform_driver_register(&ot200_backlight_driver);
>> +}
>> +module_init(ot200_backlight_init);
>> +
>> +static void __exit ot200_backlight_exit(void)
>> +{
>> + Â Â platform_driver_unregister(&ot200_backlight_driver);
>> +}
>> +module_exit(ot200_backlight_exit);
>> +
>> +MODULE_DESCRIPTION("backlight driver for Bachmann ot200");
>> +MODULE_AUTHOR("Christian Gmeiner <christian.gmeiner@xxxxxxxxx>");
>> +MODULE_LICENSE("GPL");
>> +MODULE_ALIAS("platform:ot200-backlight");
>

I will send a v2 of this patch soon
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/