b5e4dbb1f7d44f999b13ad8d4577f3e2d39a9202
[cascardo/linux.git] / drivers / media / platform / vsp1 / vsp1_entity.h
1 /*
2  * vsp1_entity.h  --  R-Car VSP1 Base Entity
3  *
4  * Copyright (C) 2013-2014 Renesas Electronics Corporation
5  *
6  * Contact: Laurent Pinchart (laurent.pinchart@ideasonboard.com)
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  */
13 #ifndef __VSP1_ENTITY_H__
14 #define __VSP1_ENTITY_H__
15
16 #include <linux/list.h>
17 #include <linux/mutex.h>
18
19 #include <media/v4l2-subdev.h>
20
21 struct vsp1_device;
22 struct vsp1_dl_list;
23 struct vsp1_pipeline;
24
25 enum vsp1_entity_type {
26         VSP1_ENTITY_BRU,
27         VSP1_ENTITY_CLU,
28         VSP1_ENTITY_HSI,
29         VSP1_ENTITY_HST,
30         VSP1_ENTITY_LIF,
31         VSP1_ENTITY_LUT,
32         VSP1_ENTITY_RPF,
33         VSP1_ENTITY_SRU,
34         VSP1_ENTITY_UDS,
35         VSP1_ENTITY_WPF,
36 };
37
38 #define VSP1_ENTITY_MAX_INPUTS          5       /* For the BRU */
39
40 /*
41  * struct vsp1_route - Entity routing configuration
42  * @type: Entity type this routing entry is associated with
43  * @index: Entity index this routing entry is associated with
44  * @reg: Output routing configuration register
45  * @inputs: Target node value for each input
46  * @output: Target node value for entity output
47  *
48  * Each $vsp1_route entry describes routing configuration for the entity
49  * specified by the entry's @type and @index. @reg indicates the register that
50  * holds output routing configuration for the entity, and the @inputs array
51  * store the target node value for each input of the entity. The @output field
52  * stores the target node value of the entity output when used as a source for
53  * histogram generation.
54  */
55 struct vsp1_route {
56         enum vsp1_entity_type type;
57         unsigned int index;
58         unsigned int reg;
59         unsigned int inputs[VSP1_ENTITY_MAX_INPUTS];
60         unsigned int output;
61 };
62
63 /**
64  * struct vsp1_entity_operations - Entity operations
65  * @destroy:    Destroy the entity.
66  * @set_memory: Setup memory buffer access. This operation applies the settings
67  *              stored in the rwpf mem field to the display list. Valid for RPF
68  *              and WPF only.
69  * @configure:  Setup the hardware based on the entity state (pipeline, formats,
70  *              selection rectangles, ...)
71  */
72 struct vsp1_entity_operations {
73         void (*destroy)(struct vsp1_entity *);
74         void (*set_memory)(struct vsp1_entity *, struct vsp1_dl_list *dl);
75         void (*configure)(struct vsp1_entity *, struct vsp1_pipeline *,
76                           struct vsp1_dl_list *, bool);
77 };
78
79 struct vsp1_entity {
80         struct vsp1_device *vsp1;
81
82         const struct vsp1_entity_operations *ops;
83
84         enum vsp1_entity_type type;
85         unsigned int index;
86         const struct vsp1_route *route;
87
88         struct list_head list_dev;
89         struct list_head list_pipe;
90
91         struct media_pad *pads;
92         unsigned int source_pad;
93
94         struct media_entity *sink;
95         unsigned int sink_pad;
96
97         struct v4l2_subdev subdev;
98         struct v4l2_subdev_pad_config *config;
99
100         struct mutex lock;      /* Protects the pad config */
101 };
102
103 static inline struct vsp1_entity *to_vsp1_entity(struct v4l2_subdev *subdev)
104 {
105         return container_of(subdev, struct vsp1_entity, subdev);
106 }
107
108 int vsp1_entity_init(struct vsp1_device *vsp1, struct vsp1_entity *entity,
109                      const char *name, unsigned int num_pads,
110                      const struct v4l2_subdev_ops *ops, u32 function);
111 void vsp1_entity_destroy(struct vsp1_entity *entity);
112
113 extern const struct v4l2_subdev_internal_ops vsp1_subdev_internal_ops;
114
115 int vsp1_entity_link_setup(struct media_entity *entity,
116                            const struct media_pad *local,
117                            const struct media_pad *remote, u32 flags);
118
119 struct v4l2_subdev_pad_config *
120 vsp1_entity_get_pad_config(struct vsp1_entity *entity,
121                            struct v4l2_subdev_pad_config *cfg,
122                            enum v4l2_subdev_format_whence which);
123 struct v4l2_mbus_framefmt *
124 vsp1_entity_get_pad_format(struct vsp1_entity *entity,
125                            struct v4l2_subdev_pad_config *cfg,
126                            unsigned int pad);
127 struct v4l2_rect *
128 vsp1_entity_get_pad_selection(struct vsp1_entity *entity,
129                               struct v4l2_subdev_pad_config *cfg,
130                               unsigned int pad, unsigned int target);
131 int vsp1_entity_init_cfg(struct v4l2_subdev *subdev,
132                          struct v4l2_subdev_pad_config *cfg);
133
134 void vsp1_entity_route_setup(struct vsp1_entity *source,
135                              struct vsp1_dl_list *dl);
136
137 int vsp1_subdev_get_pad_format(struct v4l2_subdev *subdev,
138                                struct v4l2_subdev_pad_config *cfg,
139                                struct v4l2_subdev_format *fmt);
140 int vsp1_subdev_enum_mbus_code(struct v4l2_subdev *subdev,
141                                struct v4l2_subdev_pad_config *cfg,
142                                struct v4l2_subdev_mbus_code_enum *code,
143                                const unsigned int *codes, unsigned int ncodes);
144 int vsp1_subdev_enum_frame_size(struct v4l2_subdev *subdev,
145                                 struct v4l2_subdev_pad_config *cfg,
146                                 struct v4l2_subdev_frame_size_enum *fse,
147                                 unsigned int min_w, unsigned int min_h,
148                                 unsigned int max_w, unsigned int max_h);
149
150 #endif /* __VSP1_ENTITY_H__ */