1/* SPDX-License-Identifier: GPL-2.0 */
 2/*
 3 * Copyright (C) STMicroelectronics SA 2014
 4 * Author: Benjamin Gaignard <benjamin.gaignard@st.com> for STMicroelectronics.
 5 */
 6
 7#ifndef _STI_PLANE_H_
 8#define _STI_PLANE_H_
 9
10#include <drm/drmP.h>
11#include <drm/drm_atomic_helper.h>
12#include <drm/drm_plane_helper.h>
13
14#define to_sti_plane(x) container_of(x, struct sti_plane, drm_plane)
15
16#define STI_PLANE_TYPE_SHIFT 8
17#define STI_PLANE_TYPE_MASK (~((1 << STI_PLANE_TYPE_SHIFT) - 1))
18
19enum sti_plane_type {
20	STI_GDP = 1 << STI_PLANE_TYPE_SHIFT,
21	STI_VDP = 2 << STI_PLANE_TYPE_SHIFT,
22	STI_CUR = 3 << STI_PLANE_TYPE_SHIFT,
23	STI_BCK = 4 << STI_PLANE_TYPE_SHIFT
24};
25
26enum sti_plane_id_of_type {
27	STI_ID_0 = 0,
28	STI_ID_1 = 1,
29	STI_ID_2 = 2,
30	STI_ID_3 = 3
31};
32
33enum sti_plane_desc {
34	STI_GDP_0       = STI_GDP | STI_ID_0,
35	STI_GDP_1       = STI_GDP | STI_ID_1,
36	STI_GDP_2       = STI_GDP | STI_ID_2,
37	STI_GDP_3       = STI_GDP | STI_ID_3,
38	STI_HQVDP_0     = STI_VDP | STI_ID_0,
39	STI_CURSOR      = STI_CUR,
40	STI_BACK        = STI_BCK
41};
42
43enum sti_plane_status {
44	STI_PLANE_READY,
45	STI_PLANE_UPDATED,
46	STI_PLANE_DISABLING,
47	STI_PLANE_FLUSHING,
48	STI_PLANE_DISABLED,
49};
50
51#define FPS_LENGTH 128
52struct sti_fps_info {
53	bool output;
54	unsigned int curr_frame_counter;
55	unsigned int last_frame_counter;
56	unsigned int curr_field_counter;
57	unsigned int last_field_counter;
58	ktime_t	     last_timestamp;
59	char fps_str[FPS_LENGTH];
60	char fips_str[FPS_LENGTH];
61};
62
63/**
64 * STI plane structure
65 *
66 * @plane:              drm plane it is bound to (if any)
67 * @desc:               plane type & id
68 * @status:             to know the status of the plane
69 * @fps_info:           frame per second info
70 */
71struct sti_plane {
72	struct drm_plane drm_plane;
73	enum sti_plane_desc desc;
74	enum sti_plane_status status;
75	struct sti_fps_info fps_info;
76};
77
78const char *sti_plane_to_str(struct sti_plane *plane);
79void sti_plane_update_fps(struct sti_plane *plane,
80			  bool new_frame,
81			  bool new_field);
82
83void sti_plane_init_property(struct sti_plane *plane,
84			     enum drm_plane_type type);
85void sti_plane_reset(struct drm_plane *plane);
86#endif