drivers/gpu/arm/midgard/mali_kbase_sync.h

   1 /*
   2  *
   3  * (C) COPYRIGHT ARM Limited. All rights reserved.
   4  *
   5  * This program is free software and is provided to you under the terms of the
   6  * GNU General Public License version 2 as published by the Free Software
   7  * Foundation, and any use by you of this program is subject to the terms
   8  * of such GNU licence.
   9  *
  10  * A copy of the licence is included with the program, and can also be obtained
  11  * from Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  12  * Boston, MA  02110-1301, USA.
  13  *
  14  */
  15
  16
  17
  18
  19
  20 /**
  21  * @file mali_kbase_sync.h
  22  *
  23  */
  24
  25 #ifndef MALI_KBASE_SYNC_H
  26 #define MALI_KBASE_SYNC_H
  27
  28 #include "sync.h"
  29 #include <malisw/mali_malisw.h>
  30
  31 /*
  32  * Create a stream object.
  33  * Built on top of timeline object.
  34  * Exposed as a file descriptor.
  35  * Life-time controlled via the file descriptor:
  36  * - dup to add a ref
  37  * - close to remove a ref
  38  */
  39 mali_error kbase_stream_create(const char *name, int *const out_fd);
  40
  41 /*
  42  * Create a fence in a stream object
  43  */
  44 int kbase_stream_create_fence(int tl_fd);
  45
  46 /*
  47  * Validate a fd to be a valid fence
  48  * No reference is taken.
  49  *
  50  * This function is only usable to catch unintentional user errors early,
  51  * it does not stop malicious code changing the fd after this function returns.
  52  */
  53 mali_error kbase_fence_validate(int fd);
  54
  55 /* Returns true if the specified timeline is allocated by Mali */
  56 int kbase_sync_timeline_is_ours(struct sync_timeline *timeline);
  57
  58 /* Allocates a timeline for Mali
  59  *
  60  * One timeline should be allocated per API context.
  61  */
  62 struct sync_timeline *kbase_sync_timeline_alloc(const char *name);
  63
  64 /* Allocates a sync point within the timeline.
  65  *
  66  * The timeline must be the one allocated by kbase_sync_timeline_alloc
  67  *
  68  * Sync points must be triggered in *exactly* the same order as they are allocated.
  69  */
  70 struct sync_pt *kbase_sync_pt_alloc(struct sync_timeline *parent);
  71
  72 /* Signals a particular sync point
  73  *
  74  * Sync points must be triggered in *exactly* the same order as they are allocated.
  75  *
  76  * If they are signalled in the wrong order then a message will be printed in debug
  77  * builds and otherwise attempts to signal order sync_pts will be ignored.
  78  *
  79  * result can be negative to indicate error, any other value is interpreted as success.
  80  */
  81 void kbase_sync_signal_pt(struct sync_pt *pt, int result);
  82
  83 #endif