intel_regions.h revision 8f81a6468fdbc7320800ea497791e3e1b8f782ca 
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, which is
34 * the basic structure for rectangular collections of pixels stored in a dri_bo.
35 */
36
37#include <xf86drm.h>
38
39#include "main/mtypes.h"
40#include "intel_bufmgr.h"
41
42struct intel_context;
43struct intel_buffer_object;
44
45/**
46 * A layer on top of the bufmgr buffers that adds a few useful things:
47 *
48 * - Refcounting for local buffer references.
49 * - Refcounting for buffer maps
50 * - Buffer dimensions - pitch and height.
51 * - Blitter commands for copying 2D regions between buffers. (really???)
52 */
53struct intel_region
54{
55   dri_bo *buffer;  /**< buffer manager's buffer */
56   GLuint refcount; /**< Reference count for region */
57   GLuint cpp;      /**< bytes per pixel */
58   GLuint width;    /**< in pixels */
59   GLuint height;   /**< in pixels */
60   GLuint pitch;    /**< in pixels */
61   GLubyte *map;    /**< only non-NULL when region is actually mapped */
62   GLuint map_refcount;  /**< Reference count for mapping */
63
64   GLuint draw_offset; /**< Offset of drawing address within the region */
65   uint32_t tiling; /**< Which tiling mode the region is in */
66   uint32_t bit_6_swizzle; /**< GEM flag for address swizzling requirement */
67   drmAddress classic_map; /**< drmMap of the region when not in GEM mode */
68   struct intel_buffer_object *pbo;     /* zero-copy uploads */
69};
70
71
72/* Allocate a refcounted region.  Pointers to regions should only be
73 * copied by calling intel_reference_region().
74 */
75struct intel_region *intel_region_alloc(struct intel_context *intel,
76                                        uint32_t tiling,
77					GLuint cpp, GLuint width,
78                                        GLuint height, GLuint pitch,
79					GLboolean expect_accelerated_upload);
80
81struct intel_region *
82intel_region_alloc_for_handle(struct intel_context *intel,
83			      GLuint cpp,
84			      GLuint width, GLuint height, GLuint pitch,
85			      unsigned int handle, const char *name);
86
87void intel_region_reference(struct intel_region **dst,
88                            struct intel_region *src);
89
90void intel_region_release(struct intel_region **ib);
91
92void intel_recreate_static_regions(struct intel_context *intel);
93
94/* Map/unmap regions.  This is refcounted also:
95 */
96GLubyte *intel_region_map(struct intel_context *intel,
97                          struct intel_region *ib);
98
99void intel_region_unmap(struct intel_context *intel, struct intel_region *ib);
100
101
102/* Upload data to a rectangular sub-region
103 */
104void intel_region_data(struct intel_context *intel,
105                       struct intel_region *dest,
106                       GLuint dest_offset,
107                       GLuint destx, GLuint desty,
108                       const void *src, GLuint src_stride,
109                       GLuint srcx, GLuint srcy, GLuint width, GLuint height);
110
111/* Copy rectangular sub-regions
112 */
113GLboolean
114intel_region_copy(struct intel_context *intel,
115		  struct intel_region *dest,
116		  GLuint dest_offset,
117		  GLuint destx, GLuint desty,
118		  struct intel_region *src,
119		  GLuint src_offset,
120		  GLuint srcx, GLuint srcy, GLuint width, GLuint height,
121		  GLenum logicop);
122
123/* Helpers for zerocopy uploads, particularly texture image uploads:
124 */
125void intel_region_attach_pbo(struct intel_context *intel,
126                             struct intel_region *region,
127                             struct intel_buffer_object *pbo);
128void intel_region_release_pbo(struct intel_context *intel,
129                              struct intel_region *region);
130void intel_region_cow(struct intel_context *intel,
131                      struct intel_region *region);
132
133dri_bo *intel_region_buffer(struct intel_context *intel,
134			    struct intel_region *region,
135			    GLuint flag);
136
137void _mesa_copy_rect(GLubyte * dst,
138                GLuint cpp,
139                GLuint dst_pitch,
140                GLuint dst_x,
141                GLuint dst_y,
142                GLuint width,
143                GLuint height,
144                const GLubyte * src,
145                GLuint src_pitch, GLuint src_x, GLuint src_y);
146
147#endif
148