/* * Samsung S5P/EXYNOS4 SoC series MIPI-CSI receiver driver * * Copyright (C) 2011 Samsung Electronics Co., Ltd. * Contact: Sylwester Nawrocki, <s.nawrocki@samsung.com> * * 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/clk.h> #include <linux/delay.h> #include <linux/device.h> #include <linux/errno.h> #include <linux/interrupt.h> #include <linux/io.h> #include <linux/irq.h> #include <linux/kernel.h> #include <linux/memory.h> #include <linux/module.h> #include <linux/platform_device.h> #include <linux/pm_runtime.h> #include <linux/regulator/consumer.h> #include <linux/slab.h> #include <linux/spinlock.h> #include <linux/videodev2.h> #include <media/v4l2-subdev.h> #include <plat/mipi_csis.h> #include "mipi-csis.h" static int debug; module_param(debug, int, 0644); MODULE_PARM_DESC(debug, "Debug level (0-1)"); /* Register map definition */ /* CSIS global control */ #define S5PCSIS_CTRL 0x00 #define S5PCSIS_CTRL_DPDN_DEFAULT (0 << 31) #define S5PCSIS_CTRL_DPDN_SWAP (1 << 31) #define S5PCSIS_CTRL_ALIGN_32BIT (1 << 20) #define S5PCSIS_CTRL_UPDATE_SHADOW (1 << 16) #define S5PCSIS_CTRL_WCLK_EXTCLK (1 << 8) #define S5PCSIS_CTRL_RESET (1 << 4) #define S5PCSIS_CTRL_ENABLE (1 << 0) /* D-PHY control */ #define S5PCSIS_DPHYCTRL 0x04 #define S5PCSIS_DPHYCTRL_HSS_MASK (0x1f << 27) #define S5PCSIS_DPHYCTRL_ENABLE (0x1f << 0) #define S5PCSIS_CONFIG 0x08 #define S5PCSIS_CFG_FMT_YCBCR422_8BIT (0x1e << 2) #define S5PCSIS_CFG_FMT_RAW8 (0x2a << 2) #define S5PCSIS_CFG_FMT_RAW10 (0x2b << 2) #define S5PCSIS_CFG_FMT_RAW12 (0x2c << 2) /* User defined formats, x = 1...4 */ #define S5PCSIS_CFG_FMT_USER(x) ((0x30 + x - 1) << 2) #define S5PCSIS_CFG_FMT_MASK (0x3f << 2) #define S5PCSIS_CFG_NR_LANE_MASK 3 /* Interrupt mask. */ #define S5PCSIS_INTMSK 0x10 #define S5PCSIS_INTMSK_EN_ALL 0xf000003f #define S5PCSIS_INTSRC 0x14 /* Pixel resolution */ #define S5PCSIS_RESOL 0x2c #define CSIS_MAX_PIX_WIDTH 0xffff #define CSIS_MAX_PIX_HEIGHT 0xffff enum { CSIS_CLK_MUX, CSIS_CLK_GATE, }; static char *csi_clock_name[] = { [CSIS_CLK_MUX] = "sclk_csis", [CSIS_CLK_GATE] = "csis", }; #define NUM_CSIS_CLOCKS ARRAY_SIZE(csi_clock_name) enum { ST_POWERED = 1, ST_STREAMING = 2, ST_SUSPENDED = 4, }; /** * struct csis_state - the driver's internal state data structure * @lock: mutex serializing the subdev and power management operations, * protecting @format and @flags members * @pads: CSIS pads array * @sd: v4l2_subdev associated with CSIS device instance * @pdev: CSIS platform device * @regs_res: requested I/O register memory resource * @regs: mmaped I/O registers memory * @clock: CSIS clocks * @irq: requested s5p-mipi-csis irq number * @flags: the state variable for power and streaming control * @csis_fmt: current CSIS pixel format * @format: common media bus format for the source and sink pad */ struct csis_state { struct mutex lock; struct media_pad pads[CSIS_PADS_NUM]; struct v4l2_subdev sd; struct platform_device *pdev; struct resource *regs_res; void __iomem *regs; struct clk *clock[NUM_CSIS_CLOCKS]; int irq; struct regulator *supply; u32 flags; const struct csis_pix_format *csis_fmt; struct v4l2_mbus_framefmt format; }; /** * struct csis_pix_format - CSIS pixel format description * @pix_width_alignment: horizontal pixel alignment, width will be * multiple of 2^pix_width_alignment * @code: corresponding media bus code * @fmt_reg: S5PCSIS_CONFIG register value */ struct csis_pix_format { unsigned int pix_width_alignment; enum v4l2_mbus_pixelcode code; u32 fmt_reg; }; static const struct csis_pix_format s5pcsis_formats[] = { { .code = V4L2_MBUS_FMT_VYUY8_2X8, .fmt_reg = S5PCSIS_CFG_FMT_YCBCR422_8BIT, }, { .code = V4L2_MBUS_FMT_JPEG_1X8, .fmt_reg = S5PCSIS_CFG_FMT_USER(1), }, }; #define s5pcsis_write(__csis, __r, __v) writel(__v, __csis->regs + __r) #define s5pcsis_read(__csis, __r) readl(__csis->regs + __r) static struct csis_state *sd_to_csis_state(struct v4l2_subdev *sdev) { return container_of(sdev, struct csis_state, sd); } static const struct csis_pix_format *find_csis_format( struct v4l2_mbus_framefmt *mf) { int i; for (i = 0; i < ARRAY_SIZE(s5pcsis_formats); i++) if (mf->code == s5pcsis_formats[i].code) return &s5pcsis_formats[i]; return NULL; } static void s5pcsis_enable_interrupts(struct csis_state *state, bool on) { u32 val = s5pcsis_read(state, S5PCSIS_INTMSK); val = on ? val | S5PCSIS_INTMSK_EN_ALL : val & ~S5PCSIS_INTMSK_EN_ALL; s5pcsis_write(state, S5PCSIS_INTMSK, val); } static void s5pcsis_reset(struct csis_state *state) { u32 val = s5pcsis_read(state, S5PCSIS_CTRL); s5pcsis_write(state, S5PCSIS_CTRL, val | S5PCSIS_CTRL_RESET); udelay(10); } static void s5pcsis_system_enable(struct csis_state *state, int on) { u32 val; val = s5pcsis_read(state, S5PCSIS_CTRL); if (on) val |= S5PCSIS_CTRL_ENABLE; else val &= ~S5PCSIS_CTRL_ENABLE; s5pcsis_write(state, S5PCSIS_CTRL, val); val = s5pcsis_read(state, S5PCSIS_DPHYCTRL); if (on) val |= S5PCSIS_DPHYCTRL_ENABLE; else val &= ~S5PCSIS_DPHYCTRL_ENABLE; s5pcsis_write(state, S5PCSIS_DPHYCTRL, val); } /* Called with the state.lock mutex held */ static void __s5pcsis_set_format(struct csis_state *state) { struct v4l2_mbus_framefmt *mf = &state->format; u32 val; v4l2_dbg(1, debug, &state->sd, "fmt: %d, %d x %d\n", mf->code, mf->width, mf->height); /* Color format */ val = s5pcsis_read(state, S5PCSIS_CONFIG); val = (val & ~S5PCSIS_CFG_FMT_MASK) | state->csis_fmt->fmt_reg; s5pcsis_write(state, S5PCSIS_CONFIG, val); /* Pixel resolution */ val = (mf->width << 16) | mf->height; s5pcsis_write(state, S5PCSIS_RESOL, val); } static void s5pcsis_set_hsync_settle(struct csis_state *state, int settle) { u32 val = s5pcsis_read(state, S5PCSIS_DPHYCTRL); val = (val & ~S5PCSIS_DPHYCTRL_HSS_MASK) | (settle << 27); s5pcsis_write(state, S5PCSIS_DPHYCTRL, val); } static void s5pcsis_set_params(struct csis_state *state) { struct s5p_platform_mipi_csis *pdata = state->pdev->dev.platform_data; u32 val; val = s5pcsis_read(state, S5PCSIS_CONFIG); val = (val & ~S5PCSIS_CFG_NR_LANE_MASK) | (pdata->lanes - 1); s5pcsis_write(state, S5PCSIS_CONFIG, val); __s5pcsis_set_format(state); s5pcsis_set_hsync_settle(state, pdata->hs_settle); val = s5pcsis_read(state, S5PCSIS_CTRL); if (pdata->alignment == 32) val |= S5PCSIS_CTRL_ALIGN_32BIT; else /* 24-bits */ val &= ~S5PCSIS_CTRL_ALIGN_32BIT; /* Not using external clock. */ val &= ~S5PCSIS_CTRL_WCLK_EXTCLK; s5pcsis_write(state, S5PCSIS_CTRL, val); /* Update the shadow register. */ val = s5pcsis_read(state, S5PCSIS_CTRL); s5pcsis_write(state, S5PCSIS_CTRL, val | S5PCSIS_CTRL_UPDATE_SHADOW); } static void s5pcsis_clk_put(struct csis_state *state) { int i; for (i = 0; i < NUM_CSIS_CLOCKS; i++) if (!IS_ERR_OR_NULL(state->clock[i])) clk_put(state->clock[i]); } static int s5pcsis_clk_get(struct csis_state *state) { struct device *dev = &state->pdev->dev; int i; for (i = 0; i < NUM_CSIS_CLOCKS; i++) { state->clock[i] = clk_get(dev, csi_clock_name[i]); if (IS_ERR(state->clock[i])) { s5pcsis_clk_put(state); dev_err(dev, "failed to get clock: %s\n", csi_clock_name[i]); return -ENXIO; } } return 0; } static int s5pcsis_s_power(struct v4l2_subdev *sd, int on) { struct csis_state *state = sd_to_csis_state(sd); struct device *dev = &state->pdev->dev; if (on) return pm_runtime_get_sync(dev); return pm_runtime_put_sync(dev); } static void s5pcsis_start_stream(struct csis_state *state) { s5pcsis_reset(state); s5pcsis_set_params(state); s5pcsis_system_enable(state, true); s5pcsis_enable_interrupts(state, true); } static void s5pcsis_stop_stream(struct csis_state *state) { s5pcsis_enable_interrupts(state, false); s5pcsis_system_enable(state, false); } /* v4l2_subdev operations */ static int s5pcsis_s_stream(struct v4l2_subdev *sd, int enable) { struct csis_state *state = sd_to_csis_state(sd); int ret = 0; v4l2_dbg(1, debug, sd, "%s: %d, state: 0x%x\n", __func__, enable, state->flags); if (enable) { ret = pm_runtime_get_sync(&state->pdev->dev); if (ret && ret != 1) return ret; } mutex_lock(&state->lock); if (enable) { if (state->flags & ST_SUSPENDED) { ret = -EBUSY; goto unlock; } s5pcsis_start_stream(state); state->flags |= ST_STREAMING; } else { s5pcsis_stop_stream(state); state->flags &= ~ST_STREAMING; } unlock: mutex_unlock(&state->lock); if (!enable) pm_runtime_put(&state->pdev->dev); return ret == 1 ? 0 : ret; } static int s5pcsis_enum_mbus_code(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh, struct v4l2_subdev_mbus_code_enum *code) { if (code->index >= ARRAY_SIZE(s5pcsis_formats)) return -EINVAL; code->code = s5pcsis_formats[code->index].code; return 0; } static struct csis_pix_format const *s5pcsis_try_format( struct v4l2_mbus_framefmt *mf) { struct csis_pix_format const *csis_fmt; csis_fmt = find_csis_format(mf); if (csis_fmt == NULL) csis_fmt = &s5pcsis_formats[0]; mf->code = csis_fmt->code; v4l_bound_align_image(&mf->width, 1, CSIS_MAX_PIX_WIDTH, csis_fmt->pix_width_alignment, &mf->height, 1, CSIS_MAX_PIX_HEIGHT, 1, 0); return csis_fmt; } static struct v4l2_mbus_framefmt *__s5pcsis_get_format( struct csis_state *state, struct v4l2_subdev_fh *fh, u32 pad, enum v4l2_subdev_format_whence which) { if (which == V4L2_SUBDEV_FORMAT_TRY) return fh ? v4l2_subdev_get_try_format(fh, pad) : NULL; return &state->format; } static int s5pcsis_set_fmt(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh, struct v4l2_subdev_format *fmt) { struct csis_state *state = sd_to_csis_state(sd); struct csis_pix_format const *csis_fmt; struct v4l2_mbus_framefmt *mf; if (fmt->pad != CSIS_PAD_SOURCE && fmt->pad != CSIS_PAD_SINK) return -EINVAL; mf = __s5pcsis_get_format(state, fh, fmt->pad, fmt->which); if (fmt->pad == CSIS_PAD_SOURCE) { if (mf) { mutex_lock(&state->lock); fmt->format = *mf; mutex_unlock(&state->lock); } return 0; } csis_fmt = s5pcsis_try_format(&fmt->format); if (mf) { mutex_lock(&state->lock); *mf = fmt->format; if (fmt->which == V4L2_SUBDEV_FORMAT_ACTIVE) state->csis_fmt = csis_fmt; mutex_unlock(&state->lock); } return 0; } static int s5pcsis_get_fmt(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh, struct v4l2_subdev_format *fmt) { struct csis_state *state = sd_to_csis_state(sd); struct v4l2_mbus_framefmt *mf; if (fmt->pad != CSIS_PAD_SOURCE && fmt->pad != CSIS_PAD_SINK) return -EINVAL; mf = __s5pcsis_get_format(state, fh, fmt->pad, fmt->which); if (!mf) return -EINVAL; mutex_lock(&state->lock); fmt->format = *mf; mutex_unlock(&state->lock); return 0; } static struct v4l2_subdev_core_ops s5pcsis_core_ops = { .s_power = s5pcsis_s_power, }; static struct v4l2_subdev_pad_ops s5pcsis_pad_ops = { .enum_mbus_code = s5pcsis_enum_mbus_code, .get_fmt = s5pcsis_get_fmt, .set_fmt = s5pcsis_set_fmt, }; static struct v4l2_subdev_video_ops s5pcsis_video_ops = { .s_stream = s5pcsis_s_stream, }; static struct v4l2_subdev_ops s5pcsis_subdev_ops = { .core = &s5pcsis_core_ops, .pad = &s5pcsis_pad_ops, .video = &s5pcsis_video_ops, }; static irqreturn_t s5pcsis_irq_handler(int irq, void *dev_id) { struct csis_state *state = dev_id; u32 val; /* Just clear the interrupt pending bits. */ val = s5pcsis_read(state, S5PCSIS_INTSRC); s5pcsis_write(state, S5PCSIS_INTSRC, val); return IRQ_HANDLED; } static int __devinit s5pcsis_probe(struct platform_device *pdev) { struct s5p_platform_mipi_csis *pdata; struct resource *mem_res; struct resource *regs_res; struct csis_state *state; int ret = -ENOMEM; state = kzalloc(sizeof(*state), GFP_KERNEL); if (!state) return -ENOMEM; mutex_init(&state->lock); state->pdev = pdev; pdata = pdev->dev.platform_data; if (pdata == NULL || pdata->phy_enable == NULL) { dev_err(&pdev->dev, "Platform data not fully specified\n"); goto e_free; } if ((pdev->id == 1 && pdata->lanes > CSIS1_MAX_LANES) || pdata->lanes > CSIS0_MAX_LANES) { ret = -EINVAL; dev_err(&pdev->dev, "Unsupported number of data lanes: %d\n", pdata->lanes); goto e_free; } mem_res = platform_get_resource(pdev, IORESOURCE_MEM, 0); if (!mem_res) { dev_err(&pdev->dev, "Failed to get IO memory region\n"); goto e_free; } regs_res = request_mem_region(mem_res->start, resource_size(mem_res), pdev->name); if (!regs_res) { dev_err(&pdev->dev, "Failed to request IO memory region\n"); goto e_free; } state->regs_res = regs_res; state->regs = ioremap(mem_res->start, resource_size(mem_res)); if (!state->regs) { dev_err(&pdev->dev, "Failed to remap IO region\n"); goto e_reqmem; } ret = s5pcsis_clk_get(state); if (ret) goto e_unmap; clk_enable(state->clock[CSIS_CLK_MUX]); if (pdata->clk_rate) clk_set_rate(state->clock[CSIS_CLK_MUX], pdata->clk_rate); else dev_WARN(&pdev->dev, "No clock frequency specified!\n"); state->irq = platform_get_irq(pdev, 0); if (state->irq < 0) { ret = state->irq; dev_err(&pdev->dev, "Failed to get irq\n"); goto e_clkput; } if (!pdata->fixed_phy_vdd) { state->supply = regulator_get(&pdev->dev, "vdd"); if (IS_ERR(state->supply)) { ret = PTR_ERR(state->supply); state->supply = NULL; goto e_clkput; } } ret = request_irq(state->irq, s5pcsis_irq_handler, 0, dev_name(&pdev->dev), state); if (ret) { dev_err(&pdev->dev, "request_irq failed\n"); goto e_regput; } v4l2_subdev_init(&state->sd, &s5pcsis_subdev_ops); state->sd.owner = THIS_MODULE; strlcpy(state->sd.name, dev_name(&pdev->dev), sizeof(state->sd.name)); state->csis_fmt = &s5pcsis_formats[0]; state->pads[CSIS_PAD_SINK].flags = MEDIA_PAD_FL_SINK; state->pads[CSIS_PAD_SOURCE].flags = MEDIA_PAD_FL_SOURCE; ret = media_entity_init(&state->sd.entity, CSIS_PADS_NUM, state->pads, 0); if (ret < 0) goto e_irqfree; /* This allows to retrieve the platform device id by the host driver */ v4l2_set_subdevdata(&state->sd, pdev); /* .. and a pointer to the subdev. */ platform_set_drvdata(pdev, &state->sd); state->flags = ST_SUSPENDED; pm_runtime_enable(&pdev->dev); return 0; e_irqfree: free_irq(state->irq, state); e_regput: if (state->supply) regulator_put(state->supply); e_clkput: clk_disable(state->clock[CSIS_CLK_MUX]); s5pcsis_clk_put(state); e_unmap: iounmap(state->regs); e_reqmem: release_mem_region(regs_res->start, resource_size(regs_res)); e_free: kfree(state); return ret; } static int s5pcsis_suspend(struct device *dev) { struct s5p_platform_mipi_csis *pdata = dev->platform_data; struct platform_device *pdev = to_platform_device(dev); struct v4l2_subdev *sd = platform_get_drvdata(pdev); struct csis_state *state = sd_to_csis_state(sd); int ret = 0; v4l2_dbg(1, debug, sd, "%s: flags: 0x%x\n", __func__, state->flags); mutex_lock(&state->lock); if (state->flags & ST_POWERED) { s5pcsis_stop_stream(state); ret = pdata->phy_enable(state->pdev, false); if (ret) goto unlock; if (state->supply) { ret = regulator_disable(state->supply); if (ret) goto unlock; } clk_disable(state->clock[CSIS_CLK_GATE]); state->flags &= ~ST_POWERED; } state->flags |= ST_SUSPENDED; unlock: mutex_unlock(&state->lock); return ret ? -EAGAIN : 0; } static int s5pcsis_resume(struct device *dev) { struct s5p_platform_mipi_csis *pdata = dev->platform_data; struct platform_device *pdev = to_platform_device(dev); struct v4l2_subdev *sd = platform_get_drvdata(pdev); struct csis_state *state = sd_to_csis_state(sd); int ret = 0; v4l2_dbg(1, debug, sd, "%s: flags: 0x%x\n", __func__, state->flags); mutex_lock(&state->lock); if (!(state->flags & ST_SUSPENDED)) goto unlock; if (!(state->flags & ST_POWERED)) { if (state->supply) ret = regulator_enable(state->supply); if (ret) goto unlock; ret = pdata->phy_enable(state->pdev, true); if (!ret) { state->flags |= ST_POWERED; } else if (state->supply) { regulator_disable(state->supply); goto unlock; } clk_enable(state->clock[CSIS_CLK_GATE]); } if (state->flags & ST_STREAMING) s5pcsis_start_stream(state); state->flags &= ~ST_SUSPENDED; unlock: mutex_unlock(&state->lock); return ret ? -EAGAIN : 0; } #ifdef CONFIG_PM_SLEEP static int s5pcsis_pm_suspend(struct device *dev) { return s5pcsis_suspend(dev); } static int s5pcsis_pm_resume(struct device *dev) { int ret; ret = s5pcsis_resume(dev); if (!ret) { pm_runtime_disable(dev); ret = pm_runtime_set_active(dev); pm_runtime_enable(dev); } return ret; } #endif static int __devexit s5pcsis_remove(struct platform_device *pdev) { struct v4l2_subdev *sd = platform_get_drvdata(pdev); struct csis_state *state = sd_to_csis_state(sd); struct resource *res = state->regs_res; pm_runtime_disable(&pdev->dev); s5pcsis_suspend(&pdev->dev); clk_disable(state->clock[CSIS_CLK_MUX]); pm_runtime_set_suspended(&pdev->dev); s5pcsis_clk_put(state); if (state->supply) regulator_put(state->supply); media_entity_cleanup(&state->sd.entity); free_irq(state->irq, state); iounmap(state->regs); release_mem_region(res->start, resource_size(res)); kfree(state); return 0; } static const struct dev_pm_ops s5pcsis_pm_ops = { SET_RUNTIME_PM_OPS(s5pcsis_suspend, s5pcsis_resume, NULL) SET_SYSTEM_SLEEP_PM_OPS(s5pcsis_pm_suspend, s5pcsis_pm_resume) }; static struct platform_driver s5pcsis_driver = { .probe = s5pcsis_probe, .remove = __devexit_p(s5pcsis_remove), .driver = { .name = CSIS_DRIVER_NAME, .owner = THIS_MODULE, .pm = &s5pcsis_pm_ops, }, }; static int __init s5pcsis_init(void) { return platform_driver_probe(&s5pcsis_driver, s5pcsis_probe); } static void __exit s5pcsis_exit(void) { platform_driver_unregister(&s5pcsis_driver); } module_init(s5pcsis_init); module_exit(s5pcsis_exit); MODULE_AUTHOR("Sylwester Nawrocki <s.nawrocki@samsung.com>"); MODULE_DESCRIPTION("S5P/EXYNOS4 MIPI CSI receiver driver"); MODULE_LICENSE("GPL");