2 * Greybus Camera protocol driver.
4 * Copyright 2015 Google Inc.
5 * Copyright 2015 Linaro Ltd.
7 * Released under the GPLv2 only.
10 #include <linux/debugfs.h>
12 #include <linux/kernel.h>
13 #include <linux/module.h>
14 #include <linux/slab.h>
15 #include <linux/string.h>
16 #include <linux/uaccess.h>
17 #include <linux/vmalloc.h>
19 #include "gb-camera.h"
21 #include "greybus_protocols.h"
23 enum gb_camera_debugs_buffer_id {
24 GB_CAMERA_DEBUGFS_BUFFER_CAPABILITIES,
25 GB_CAMERA_DEBUGFS_BUFFER_STREAMS,
26 GB_CAMERA_DEBUGFS_BUFFER_CAPTURE,
27 GB_CAMERA_DEBUGFS_BUFFER_FLUSH,
28 GB_CAMERA_DEBUGFS_BUFFER_MAX,
31 struct gb_camera_debugfs_buffer {
37 * struct gb_camera - A Greybus Camera Device
38 * @connection: the greybus connection for camera control
39 * @data_connected: whether the data connection has been established
40 * @debugfs: debugfs entries for camera protocol operations testing
43 struct gb_connection *connection;
48 struct gb_camera_debugfs_buffer *buffers;
52 struct gb_camera_stream_config {
58 unsigned int max_size;
61 struct gb_camera_fmt_map {
62 enum v4l2_mbus_pixelcode mbus_code;
63 unsigned int gb_format;
66 /* GB format to media code map */
67 static const struct gb_camera_fmt_map mbus_to_gbus_format[] = {
69 .mbus_code = V4L2_MBUS_FMT_UYVY8_1X16,
73 .mbus_code = V4L2_MBUS_FMT_NV12_1x8,
77 .mbus_code = V4L2_MBUS_FMT_NV21_1x8,
81 .mbus_code = V4L2_MBUS_FMT_YU12_1x8,
85 .mbus_code = V4L2_MBUS_FMT_YV12_1x8,
89 .mbus_code = V4L2_MBUS_FMT_JPEG_1X8,
94 #define ES2_APB_CDSI0_CPORT 16
95 #define ES2_APB_CDSI1_CPORT 17
97 #define GB_CAMERA_MAX_SETTINGS_SIZE 8192
99 #define gcam_dbg(gcam, format...) \
100 dev_dbg(&gcam->connection->bundle->dev, format)
101 #define gcam_info(gcam, format...) \
102 dev_info(&gcam->connection->bundle->dev, format)
103 #define gcam_err(gcam, format...) \
104 dev_err(&gcam->connection->bundle->dev, format)
106 /* -----------------------------------------------------------------------------
107 * Camera Protocol Operations
110 static int gb_camera_set_intf_power_mode(struct gb_camera *gcam, u8 intf_id,
113 struct gb_svc *svc = gcam->connection->hd->svc;
117 ret = gb_svc_intf_set_power_mode(svc, intf_id,
118 GB_SVC_UNIPRO_HS_SERIES_A,
119 GB_SVC_UNIPRO_FAST_MODE, 2, 2,
120 GB_SVC_UNIPRO_FAST_MODE, 2, 2,
121 GB_SVC_PWRM_RXTERMINATION |
122 GB_SVC_PWRM_TXTERMINATION, 0);
124 ret = gb_svc_intf_set_power_mode(svc, intf_id,
125 GB_SVC_UNIPRO_HS_SERIES_A,
126 GB_SVC_UNIPRO_SLOW_AUTO_MODE,
128 GB_SVC_UNIPRO_SLOW_AUTO_MODE,
135 static int gb_camera_set_power_mode(struct gb_camera *gcam, bool hs)
137 struct gb_interface *intf = gcam->connection->intf;
138 struct gb_svc *svc = gcam->connection->hd->svc;
141 ret = gb_camera_set_intf_power_mode(gcam, intf->interface_id, hs);
143 gcam_err(gcam, "failed to set module interface to %s (%d)\n",
144 hs ? "HS" : "PWM", ret);
148 ret = gb_camera_set_intf_power_mode(gcam, svc->ap_intf_id, hs);
150 gb_camera_set_intf_power_mode(gcam, intf->interface_id, !hs);
151 gcam_err(gcam, "failed to set AP interface to %s (%d)\n",
152 hs ? "HS" : "PWM", ret);
159 struct ap_csi_config_request {
162 #define GB_CAMERA_CSI_FLAG_CLOCK_CONTINUOUS 0x01
166 __le32 lines_per_second;
169 static int gb_camera_configure_streams(struct gb_camera *gcam,
170 unsigned int *num_streams,
172 struct gb_camera_stream_config *streams)
174 struct gb_camera_configure_streams_request *req;
175 struct gb_camera_configure_streams_response *resp;
176 struct ap_csi_config_request csi_cfg;
178 unsigned int nstreams = *num_streams;
184 if (nstreams > GB_CAMERA_MAX_STREAMS)
187 req_size = sizeof(*req) + nstreams * sizeof(req->config[0]);
188 resp_size = sizeof(*resp) + nstreams * sizeof(resp->config[0]);
190 req = kmalloc(req_size, GFP_KERNEL);
191 resp = kmalloc(resp_size, GFP_KERNEL);
197 req->num_streams = nstreams;
201 for (i = 0; i < nstreams; ++i) {
202 struct gb_camera_stream_config_request *cfg = &req->config[i];
204 cfg->width = cpu_to_le16(streams[i].width);
205 cfg->height = cpu_to_le16(streams[i].height);
206 cfg->format = cpu_to_le16(streams[i].format);
210 ret = gb_operation_sync(gcam->connection,
211 GB_CAMERA_TYPE_CONFIGURE_STREAMS,
212 req, req_size, resp, resp_size);
216 if (resp->num_streams > nstreams) {
217 gcam_dbg(gcam, "got #streams %u > request %u\n",
218 resp->num_streams, nstreams);
223 if (resp->padding != 0) {
224 gcam_dbg(gcam, "response padding != 0");
229 for (i = 0; i < nstreams; ++i) {
230 struct gb_camera_stream_config_response *cfg = &resp->config[i];
232 streams[i].width = le16_to_cpu(cfg->width);
233 streams[i].height = le16_to_cpu(cfg->height);
234 streams[i].format = le16_to_cpu(cfg->format);
235 streams[i].vc = cfg->virtual_channel;
236 streams[i].dt[0] = cfg->data_type[0];
237 streams[i].dt[1] = cfg->data_type[1];
238 streams[i].max_size = le32_to_cpu(cfg->max_size);
240 if (cfg->padding[0] || cfg->padding[1] || cfg->padding[2]) {
241 gcam_dbg(gcam, "stream #%u padding != 0", i);
247 if ((resp->flags & GB_CAMERA_CONFIGURE_STREAMS_ADJUSTED) ||
248 (*flags & GB_CAMERA_CONFIGURE_STREAMS_TEST_ONLY)) {
249 *flags = resp->flags;
250 *num_streams = resp->num_streams;
254 /* Setup unipro link speed. */
255 ret = gb_camera_set_power_mode(gcam, nstreams != 0);
260 * Configure the APB1 CSI transmitter using the lines count reported by
261 * the camera module, but with hard-coded bus frequency and lanes number.
263 * TODO: use the clocking and size informations reported by camera module
264 * to compute the required CSI bandwidth, and configure the CSI receiver
265 * on AP side, and the CSI transmitter on APB1 side accordingly.
267 memset(&csi_cfg, 0, sizeof(csi_cfg));
272 csi_cfg.num_lanes = 4;
273 csi_cfg.bus_freq = cpu_to_le32(960000000);
274 csi_cfg.lines_per_second = resp->lines_per_second;
275 ret = gb_hd_output(gcam->connection->hd, &csi_cfg,
277 GB_APB_REQUEST_CSI_TX_CONTROL, false);
280 ret = gb_hd_output(gcam->connection->hd, &csi_cfg,
282 GB_APB_REQUEST_CSI_TX_CONTROL, false);
286 gcam_err(gcam, "failed to %s the CSI transmitter\n",
287 nstreams ? "start" : "stop");
289 *flags = resp->flags;
290 *num_streams = resp->num_streams;
299 static int gb_camera_capture(struct gb_camera *gcam, u32 request_id,
300 unsigned int streams, unsigned int num_frames,
301 size_t settings_size, const void *settings)
303 struct gb_camera_capture_request *req;
307 if (settings_size > GB_CAMERA_MAX_SETTINGS_SIZE)
310 req_size = sizeof(*req) + settings_size;
311 req = kmalloc(req_size, GFP_KERNEL);
315 req->request_id = cpu_to_le32(request_id);
316 req->streams = streams;
318 req->num_frames = cpu_to_le16(num_frames);
319 memcpy(req->settings, settings, settings_size);
321 ret = gb_operation_sync(gcam->connection, GB_CAMERA_TYPE_CAPTURE,
322 req, req_size, NULL, 0);
329 static int gb_camera_flush(struct gb_camera *gcam, u32 *request_id)
331 struct gb_camera_flush_response resp;
334 ret = gb_operation_sync(gcam->connection, GB_CAMERA_TYPE_FLUSH, NULL, 0,
335 &resp, sizeof(resp));
340 *request_id = le32_to_cpu(resp.request_id);
345 static int gb_camera_event_recv(u8 type, struct gb_operation *op)
347 struct gb_camera *gcam = op->connection->private;
348 struct gb_camera_metadata_request *payload;
349 struct gb_message *request;
351 if (type != GB_CAMERA_TYPE_METADATA) {
352 gcam_err(gcam, "Unsupported unsolicited event: %u\n", type);
356 request = op->request;
358 if (request->payload_size < sizeof(*payload)) {
359 gcam_err(gcam, "Wrong event size received (%zu < %zu)\n",
360 request->payload_size, sizeof(*payload));
364 payload = request->payload;
366 gcam_dbg(gcam, "received metadata for request %u, frame %u, stream %u\n",
367 payload->request_id, payload->frame_number, payload->stream);
372 /* -----------------------------------------------------------------------------
373 * Interface with HOST ara camera.
375 static unsigned int gb_camera_mbus_to_gb(enum v4l2_mbus_pixelcode mbus_code)
379 for (i = 0; i < ARRAY_SIZE(mbus_to_gbus_format); i++) {
380 if (mbus_to_gbus_format[i].mbus_code == mbus_code)
381 return mbus_to_gbus_format[i].gb_format;
383 return mbus_to_gbus_format[0].gb_format;
386 static enum v4l2_mbus_pixelcode gb_camera_gb_to_mbus(u16 gb_fmt)
390 for (i = 0; i < ARRAY_SIZE(mbus_to_gbus_format); i++) {
391 if (mbus_to_gbus_format[i].gb_format == gb_fmt)
392 return mbus_to_gbus_format[i].mbus_code;
394 return mbus_to_gbus_format[0].mbus_code;
397 static int gb_camera_op_configure_streams(void *priv, unsigned int *nstreams,
398 unsigned int *flags, struct gb_camera_stream *streams)
400 struct gb_camera *gcam = priv;
401 struct gb_camera_stream_config *gb_streams;
402 unsigned int gb_flags = 0;
403 unsigned int gb_nstreams = *nstreams;
407 if (gb_nstreams > GB_CAMERA_MAX_STREAMS)
410 gb_streams = kzalloc(gb_nstreams * sizeof(*gb_streams), GFP_KERNEL);
414 for (i = 0; i < gb_nstreams; i++) {
415 gb_streams[i].width = streams[i].width;
416 gb_streams[i].height = streams[i].height;
417 gb_streams[i].format =
418 gb_camera_mbus_to_gb(streams[i].pixel_code);
421 if (*flags & GB_CAMERA_IN_FLAG_TEST)
422 gb_flags |= GB_CAMERA_CONFIGURE_STREAMS_TEST_ONLY;
424 ret = gb_camera_configure_streams(gcam, &gb_nstreams,
425 &gb_flags, gb_streams);
428 if (gb_nstreams > *nstreams) {
434 if (gb_flags & GB_CAMERA_CONFIGURE_STREAMS_ADJUSTED)
435 *flags |= GB_CAMERA_OUT_FLAG_ADJUSTED;
437 for (i = 0; i < gb_nstreams; i++) {
438 streams[i].width = gb_streams[i].width;
439 streams[i].height = gb_streams[i].height;
440 streams[i].vc = gb_streams[i].vc;
441 streams[i].dt[0] = gb_streams[i].dt[0];
442 streams[i].dt[1] = gb_streams[i].dt[1];
443 streams[i].max_size = gb_streams[i].max_size;
444 streams[i].pixel_code =
445 gb_camera_gb_to_mbus(gb_streams[i].format);
447 *nstreams = gb_nstreams;
454 static int gb_camera_op_capture(void *priv, u32 request_id,
455 unsigned int streams, unsigned int num_frames,
456 size_t settings_size, const void *settings)
458 return gb_camera_capture(priv, request_id, streams, num_frames,
459 settings_size, settings);
462 static int gb_camera_op_flush(void *priv, u32 *request_id)
464 return gb_camera_flush(priv, request_id);
467 struct gb_camera_ops gb_cam_ops = {
468 .configure_streams = gb_camera_op_configure_streams,
469 .capture = gb_camera_op_capture,
470 .flush = gb_camera_op_flush,
473 static int gb_camera_register_intf_ops(struct gb_camera *gcam)
475 return gb_camera_register(&gb_cam_ops, gcam);
478 /* -----------------------------------------------------------------------------
481 static ssize_t gb_camera_debugfs_capabilities(struct gb_camera *gcam,
482 char *buf, size_t len)
487 static ssize_t gb_camera_debugfs_configure_streams(struct gb_camera *gcam,
488 char *buf, size_t len)
490 struct gb_camera_debugfs_buffer *buffer =
491 &gcam->debugfs.buffers[GB_CAMERA_DEBUGFS_BUFFER_STREAMS];
492 struct gb_camera_stream_config *streams;
493 unsigned int nstreams;
499 /* Retrieve number of streams to configure */
500 token = strsep(&buf, ";");
504 ret = kstrtouint(token, 10, &nstreams);
508 if (nstreams > GB_CAMERA_MAX_STREAMS)
511 token = strsep(&buf, ";");
515 ret = kstrtouint(token, 10, &flags);
519 /* For each stream to configure parse width, height and format */
520 streams = kzalloc(nstreams * sizeof(*streams), GFP_KERNEL);
524 for (i = 0; i < nstreams; ++i) {
525 struct gb_camera_stream_config *stream = &streams[i];
528 token = strsep(&buf, ";");
533 ret = kstrtouint(token, 10, &stream->width);
538 token = strsep(&buf, ";");
542 ret = kstrtouint(token, 10, &stream->height);
546 /* Image format code */
547 token = strsep(&buf, ";");
551 ret = kstrtouint(token, 16, &stream->format);
556 ret = gb_camera_configure_streams(gcam, &nstreams, &flags, streams);
560 buffer->length = sprintf(buffer->data, "%u;%u;", nstreams, flags);
562 for (i = 0; i < nstreams; ++i) {
563 struct gb_camera_stream_config *stream = &streams[i];
565 buffer->length += sprintf(buffer->data + buffer->length,
566 "%u;%u;%u;%u;%u;%u;%u;",
567 stream->width, stream->height,
568 stream->format, stream->vc,
569 stream->dt[0], stream->dt[1],
580 static ssize_t gb_camera_debugfs_capture(struct gb_camera *gcam,
581 char *buf, size_t len)
583 unsigned int request_id;
584 unsigned int streams_mask;
585 unsigned int num_frames;
590 token = strsep(&buf, ";");
593 ret = kstrtouint(token, 10, &request_id);
598 token = strsep(&buf, ";");
601 ret = kstrtouint(token, 16, &streams_mask);
605 /* number of frames */
606 token = strsep(&buf, ";");
609 ret = kstrtouint(token, 10, &num_frames);
613 ret = gb_camera_capture(gcam, request_id, streams_mask, num_frames, 0,
621 static ssize_t gb_camera_debugfs_flush(struct gb_camera *gcam,
622 char *buf, size_t len)
624 struct gb_camera_debugfs_buffer *buffer =
625 &gcam->debugfs.buffers[GB_CAMERA_DEBUGFS_BUFFER_FLUSH];
629 ret = gb_camera_flush(gcam, &req_id);
633 buffer->length = sprintf(buffer->data, "%u", req_id);
638 struct gb_camera_debugfs_entry {
642 ssize_t (*execute)(struct gb_camera *gcam, char *buf, size_t len);
645 static const struct gb_camera_debugfs_entry gb_camera_debugfs_entries[] = {
647 .name = "capabilities",
648 .mask = S_IFREG | S_IRUGO,
649 .buffer = GB_CAMERA_DEBUGFS_BUFFER_CAPABILITIES,
650 .execute = gb_camera_debugfs_capabilities,
652 .name = "configure_streams",
653 .mask = S_IFREG | S_IRUGO | S_IWUGO,
654 .buffer = GB_CAMERA_DEBUGFS_BUFFER_STREAMS,
655 .execute = gb_camera_debugfs_configure_streams,
658 .mask = S_IFREG | S_IRUGO | S_IWUGO,
659 .buffer = GB_CAMERA_DEBUGFS_BUFFER_CAPTURE,
660 .execute = gb_camera_debugfs_capture,
663 .mask = S_IFREG | S_IRUGO | S_IWUGO,
664 .buffer = GB_CAMERA_DEBUGFS_BUFFER_FLUSH,
665 .execute = gb_camera_debugfs_flush,
669 static ssize_t gb_camera_debugfs_read(struct file *file, char __user *buf,
670 size_t len, loff_t *offset)
672 const struct gb_camera_debugfs_entry *op = file->private_data;
673 struct gb_camera *gcam = file->f_inode->i_private;
674 struct gb_camera_debugfs_buffer *buffer;
677 /* For read-only entries the operation is triggered by a read. */
678 if (!(op->mask & S_IWUGO)) {
679 ret = op->execute(gcam, NULL, 0);
684 buffer = &gcam->debugfs.buffers[op->buffer];
686 return simple_read_from_buffer(buf, len, offset, buffer->data,
690 static ssize_t gb_camera_debugfs_write(struct file *file,
691 const char __user *buf, size_t len,
694 const struct gb_camera_debugfs_entry *op = file->private_data;
695 struct gb_camera *gcam = file->f_inode->i_private;
702 kbuf = kmalloc(len + 1, GFP_KERNEL);
706 if (copy_from_user(kbuf, buf, len)) {
713 ret = op->execute(gcam, kbuf, len);
720 static int gb_camera_debugfs_open(struct inode *inode, struct file *file)
724 for (i = 0; i < ARRAY_SIZE(gb_camera_debugfs_entries); ++i) {
725 const struct gb_camera_debugfs_entry *entry =
726 &gb_camera_debugfs_entries[i];
728 if (!strcmp(file->f_path.dentry->d_iname, entry->name)) {
729 file->private_data = (void *)entry;
737 static const struct file_operations gb_camera_debugfs_ops = {
738 .open = gb_camera_debugfs_open,
739 .read = gb_camera_debugfs_read,
740 .write = gb_camera_debugfs_write,
743 static int gb_camera_debugfs_init(struct gb_camera *gcam)
745 struct gb_connection *connection = gcam->connection;
750 * Create root debugfs entry and a file entry for each camera operation.
752 snprintf(dirname, 27, "camera-%u.%u", connection->intf->interface_id,
753 connection->bundle->id);
755 gcam->debugfs.root = debugfs_create_dir(dirname, gb_debugfs_get());
756 if (IS_ERR(gcam->debugfs.root)) {
757 gcam_err(gcam, "debugfs root create failed (%ld)\n",
758 PTR_ERR(gcam->debugfs.root));
759 return PTR_ERR(gcam->debugfs.root);
762 gcam->debugfs.buffers = vmalloc(sizeof(*gcam->debugfs.buffers) *
763 GB_CAMERA_DEBUGFS_BUFFER_MAX);
764 if (!gcam->debugfs.buffers)
767 for (i = 0; i < ARRAY_SIZE(gb_camera_debugfs_entries); ++i) {
768 const struct gb_camera_debugfs_entry *entry =
769 &gb_camera_debugfs_entries[i];
770 struct dentry *dentry;
772 gcam->debugfs.buffers[i].length = 0;
774 dentry = debugfs_create_file(entry->name, entry->mask,
775 gcam->debugfs.root, gcam,
776 &gb_camera_debugfs_ops);
777 if (IS_ERR(dentry)) {
779 "debugfs operation %s create failed (%ld)\n",
780 entry->name, PTR_ERR(gcam->debugfs.root));
781 return PTR_ERR(dentry);
788 static void gb_camera_debugfs_cleanup(struct gb_camera *gcam)
790 if (gcam->debugfs.root)
791 debugfs_remove_recursive(gcam->debugfs.root);
793 vfree(gcam->debugfs.buffers);
796 /* -----------------------------------------------------------------------------
800 static void gb_camera_cleanup(struct gb_camera *gcam)
802 gb_camera_debugfs_cleanup(gcam);
804 if (gcam->data_connected) {
805 struct gb_interface *intf = gcam->connection->intf;
806 struct gb_svc *svc = gcam->connection->hd->svc;
808 gb_svc_connection_destroy(svc, intf->interface_id,
809 ES2_APB_CDSI0_CPORT, svc->ap_intf_id,
810 ES2_APB_CDSI1_CPORT);
816 static int gb_camera_connection_init(struct gb_connection *connection)
818 struct gb_svc *svc = connection->hd->svc;
819 struct gb_camera *gcam;
822 gcam = kzalloc(sizeof(*gcam), GFP_KERNEL);
826 gcam->connection = connection;
827 connection->private = gcam;
830 * Create the data connection between camera module CDSI0 and APB CDS1.
831 * The CPort IDs are hardcoded by the ES2 bridges.
833 ret = gb_svc_connection_create(svc, connection->intf->interface_id,
834 ES2_APB_CDSI0_CPORT, svc->ap_intf_id,
835 ES2_APB_CDSI1_CPORT, false);
839 gcam->data_connected = true;
841 ret = gb_camera_debugfs_init(gcam);
845 ret = gb_camera_register_intf_ops(gcam);
852 gb_camera_cleanup(gcam);
856 static void gb_camera_connection_exit(struct gb_connection *connection)
858 struct gb_camera *gcam = connection->private;
860 gb_camera_cleanup(gcam);
863 static struct gb_protocol camera_protocol = {
865 .id = GREYBUS_PROTOCOL_CAMERA_MGMT,
866 .major = GB_CAMERA_VERSION_MAJOR,
867 .minor = GB_CAMERA_VERSION_MINOR,
868 .connection_init = gb_camera_connection_init,
869 .connection_exit = gb_camera_connection_exit,
870 .request_recv = gb_camera_event_recv,
873 gb_protocol_driver(&camera_protocol);
875 MODULE_LICENSE("GPL v2");