1/**************************************************************************
2 *
3 * Copyright 2006 Tungsten Graphics, Inc., Cedar Park, Texas.
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 TUNGSTEN GRAPHICS 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#ifdef __cplusplus
45extern "C" {
46#endif
47
48struct intel_context;
49struct intel_buffer_object;
50
51/**
52 * A layer on top of the bufmgr buffers that adds a few useful things:
53 *
54 * - Refcounting for local buffer references.
55 * - Refcounting for buffer maps
56 * - Buffer dimensions - pitch and height.
57 * - Blitter commands for copying 2D regions between buffers. (really???)
58 */
59struct intel_region
60{
61   drm_intel_bo *bo;  /**< buffer manager's buffer */
62   GLuint refcount; /**< Reference count for region */
63   GLuint cpp;      /**< bytes per pixel */
64   GLuint width;    /**< in pixels */
65   GLuint height;   /**< in pixels */
66   GLuint pitch;    /**< in pixels */
67   GLubyte *map;    /**< only non-NULL when region is actually mapped */
68   GLuint map_refcount;  /**< Reference count for mapping */
69
70   uint32_t tiling; /**< Which tiling mode the region is in */
71
72   uint32_t name; /**< Global name for the bo */
73   struct intel_screen *screen;
74};
75
76
77/* Allocate a refcounted region.  Pointers to regions should only be
78 * copied by calling intel_reference_region().
79 */
80struct intel_region *intel_region_alloc(struct intel_screen *screen,
81                                        uint32_t tiling,
82					GLuint cpp, GLuint width,
83                                        GLuint height,
84					bool expect_accelerated_upload);
85
86struct intel_region *
87intel_region_alloc_for_handle(struct intel_screen *screen,
88			      GLuint cpp,
89			      GLuint width, GLuint height, GLuint pitch,
90			      unsigned int handle, const char *name);
91
92bool
93intel_region_flink(struct intel_region *region, uint32_t *name);
94
95void intel_region_reference(struct intel_region **dst,
96                            struct intel_region *src);
97
98void intel_region_release(struct intel_region **ib);
99
100void intel_recreate_static_regions(struct intel_context *intel);
101
102/**
103 * Map/unmap regions.  This is refcounted also:
104 *
105 * \param mode  bitmask of GL_MAP_READ_BIT, GL_MAP_WRITE_BIT
106 */
107void *intel_region_map(struct intel_context *intel,
108		       struct intel_region *ib,
109		       GLbitfield mode);
110
111void intel_region_unmap(struct intel_context *intel, struct intel_region *ib);
112
113/* Copy rectangular sub-regions
114 */
115bool
116intel_region_copy(struct intel_context *intel,
117		  struct intel_region *dest,
118		  GLuint dest_offset,
119		  GLuint destx, GLuint desty,
120		  struct intel_region *src,
121		  GLuint src_offset,
122		  GLuint srcx, GLuint srcy, GLuint width, GLuint height,
123		  bool flip,
124		  GLenum logicop);
125
126void _mesa_copy_rect(GLubyte * dst,
127                GLuint cpp,
128                GLuint dst_pitch,
129                GLuint dst_x,
130                GLuint dst_y,
131                GLuint width,
132                GLuint height,
133                const GLubyte * src,
134                GLuint src_pitch, GLuint src_x, GLuint src_y);
135
136void
137intel_region_get_tile_masks(struct intel_region *region,
138                            uint32_t *mask_x, uint32_t *mask_y,
139                            bool map_stencil_as_y_tiled);
140
141uint32_t
142intel_region_get_aligned_offset(struct intel_region *region, uint32_t x,
143                                uint32_t y, bool map_stencil_as_y_tiled);
144
145/**
146 * Used with images created with image_from_names
147 * to help support planar images.
148 */
149struct intel_image_format {
150   int fourcc;
151   int components;
152   int nplanes;
153   struct {
154      int buffer_index;
155      int width_shift;
156      int height_shift;
157      uint32_t dri_format;
158      int cpp;
159   } planes[3];
160};
161
162struct __DRIimageRec {
163   struct intel_region *region;
164   GLenum internal_format;
165   uint32_t dri_format;
166   GLuint format;
167   uint32_t offset;
168
169   /*
170    * Need to save these here between calls to
171    * image_from_names and calls to image_from_planar.
172    */
173   uint32_t strides[3];
174   uint32_t offsets[3];
175   struct intel_image_format *planar_format;
176
177   void *data;
178};
179
180#ifdef __cplusplus
181}
182#endif
183
184#endif
185