1 /**************************************************************************
2  *
3  * Copyright 2006 VMware, Inc.
4  * All Rights Reserved.
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a
7  * copy of this software and associated documentation files (the
8  * "Software"), to deal in the Software without restriction, including
9  * without limitation the rights to use, copy, modify, merge, publish,
10  * distribute, sub license, and/or sell copies of the Software, and to
11  * permit persons to whom the Software is furnished to do so, subject to
12  * the following conditions:
13  *
14  * The above copyright notice and this permission notice (including the
15  * next paragraph) shall be included in all copies or substantial portions
16  * of the Software.
17  *
18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
19  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
21  * IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS BE LIABLE FOR
22  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
23  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
24  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
25  *
26  **************************************************************************/
27 
28 #ifndef INTEL_REGIONS_H
29 #define INTEL_REGIONS_H
30 
31 /** @file intel_regions.h
32  *
33  * Structure definitions and prototypes for intel_region handling,
34  * which is the basic structure for rectangular collections of pixels
35  * stored in a drm_intel_bo.
36  */
37 
38 #include <stdbool.h>
39 #include <xf86drm.h>
40 
41 #include "main/mtypes.h"
42 #include "intel_bufmgr.h"
43 
44 struct intel_context;
45 struct intel_screen;
46 struct intel_buffer_object;
47 
48 /**
49  * A layer on top of the bufmgr buffers that adds a few useful things:
50  *
51  * - Refcounting for local buffer references.
52  * - Refcounting for buffer maps
53  * - Buffer dimensions - pitch and height.
54  * - Blitter commands for copying 2D regions between buffers. (really???)
55  */
56 struct intel_region
57 {
58    drm_intel_bo *bo;  /**< buffer manager's buffer */
59    GLuint refcount; /**< Reference count for region */
60    GLuint cpp;      /**< bytes per pixel */
61    GLuint width;    /**< in pixels */
62    GLuint height;   /**< in pixels */
63    GLuint pitch;    /**< in bytes */
64 
65    uint32_t tiling; /**< Which tiling mode the region is in */
66 
67    uint32_t name; /**< Global name for the bo */
68 };
69 
70 
71 /* Allocate a refcounted region.  Pointers to regions should only be
72  * copied by calling intel_reference_region().
73  */
74 struct intel_region *intel_region_alloc(struct intel_screen *screen,
75                                         uint32_t tiling,
76 					GLuint cpp, GLuint width,
77                                         GLuint height,
78 					bool expect_accelerated_upload);
79 
80 struct intel_region *
81 intel_region_alloc_for_handle(struct intel_screen *screen,
82 			      GLuint cpp,
83 			      GLuint width, GLuint height, GLuint pitch,
84 			      unsigned int handle, const char *name);
85 
86 struct intel_region *
87 intel_region_alloc_for_fd(struct intel_screen *screen,
88                           GLuint cpp,
89                           GLuint width, GLuint height, GLuint pitch,
90                           GLuint size, int fd, const char *name);
91 
92 bool
93 intel_region_flink(struct intel_region *region, uint32_t *name);
94 
95 void intel_region_reference(struct intel_region **dst,
96                             struct intel_region *src);
97 
98 void intel_region_release(struct intel_region **ib);
99 
100 void intel_recreate_static_regions(struct intel_context *intel);
101 
102 void
103 intel_region_get_tile_masks(struct intel_region *region,
104                             uint32_t *mask_x, uint32_t *mask_y);
105 
106 uint32_t
107 intel_region_get_aligned_offset(struct intel_region *region, uint32_t x,
108                                 uint32_t y);
109 
110 /**
111  * Used with images created with image_from_names
112  * to help support planar images.
113  */
114 struct intel_image_format {
115    int fourcc;
116    int components;
117    int nplanes;
118    struct {
119       int buffer_index;
120       int width_shift;
121       int height_shift;
122       uint32_t dri_format;
123       int cpp;
124    } planes[3];
125 };
126 
127 struct __DRIimageRec {
128    struct intel_region *region;
129    GLenum internal_format;
130    uint32_t dri_format;
131    GLuint format;
132    uint32_t offset;
133 
134    /*
135     * Need to save these here between calls to
136     * image_from_names and calls to image_from_planar.
137     */
138    uint32_t strides[3];
139    uint32_t offsets[3];
140    struct intel_image_format *planar_format;
141 
142    /* particular miptree level */
143    GLuint width;
144    GLuint height;
145    GLuint tile_x;
146    GLuint tile_y;
147 
148    void *data;
149 };
150 
151 #endif
152