drivers/staging/vc04_services/interface/vchiq_arm/vchiq_if.h

   1 /* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */
   2 /* Copyright (c) 2010-2012 Broadcom. All rights reserved. */
   3
   4 #ifndef VCHIQ_IF_H
   5 #define VCHIQ_IF_H
   6
   7 #define VCHIQ_SERVICE_HANDLE_INVALID 0
   8
   9 #define VCHIQ_SLOT_SIZE     4096
  10 #define VCHIQ_MAX_MSG_SIZE  (VCHIQ_SLOT_SIZE - sizeof(struct vchiq_header))
  11 #define VCHIQ_CHANNEL_SIZE  VCHIQ_MAX_MSG_SIZE /* For backwards compatibility */
  12
  13 #define VCHIQ_MAKE_FOURCC(x0, x1, x2, x3) \
  14                         (((x0) << 24) | ((x1) << 16) | ((x2) << 8) | (x3))
  15 #define VCHIQ_GET_SERVICE_USERDATA(service) vchiq_get_service_userdata(service)
  16 #define VCHIQ_GET_SERVICE_FOURCC(service)   vchiq_get_service_fourcc(service)
  17
  18 enum vchiq_reason {
  19         VCHIQ_SERVICE_OPENED,         /* service, -, -             */
  20         VCHIQ_SERVICE_CLOSED,         /* service, -, -             */
  21         VCHIQ_MESSAGE_AVAILABLE,      /* service, header, -        */
  22         VCHIQ_BULK_TRANSMIT_DONE,     /* service, -, bulk_userdata */
  23         VCHIQ_BULK_RECEIVE_DONE,      /* service, -, bulk_userdata */
  24         VCHIQ_BULK_TRANSMIT_ABORTED,  /* service, -, bulk_userdata */
  25         VCHIQ_BULK_RECEIVE_ABORTED    /* service, -, bulk_userdata */
  26 };
  27
  28 enum vchiq_status {
  29         VCHIQ_ERROR   = -1,
  30         VCHIQ_SUCCESS = 0,
  31         VCHIQ_RETRY   = 1
  32 };
  33
  34 enum vchiq_bulk_mode {
  35         VCHIQ_BULK_MODE_CALLBACK,
  36         VCHIQ_BULK_MODE_BLOCKING,
  37         VCHIQ_BULK_MODE_NOCALLBACK,
  38         VCHIQ_BULK_MODE_WAITING         /* Reserved for internal use */
  39 };
  40
  41 enum vchiq_service_option {
  42         VCHIQ_SERVICE_OPTION_AUTOCLOSE,
  43         VCHIQ_SERVICE_OPTION_SLOT_QUOTA,
  44         VCHIQ_SERVICE_OPTION_MESSAGE_QUOTA,
  45         VCHIQ_SERVICE_OPTION_SYNCHRONOUS,
  46         VCHIQ_SERVICE_OPTION_TRACE
  47 };
  48
  49 struct vchiq_header {
  50         /* The message identifier - opaque to applications. */
  51         int msgid;
  52
  53         /* Size of message data. */
  54         unsigned int size;
  55
  56         char data[0];           /* message */
  57 };
  58
  59 struct vchiq_element {
  60         const void __user *data;
  61         unsigned int size;
  62 };
  63
  64 typedef enum vchiq_status (*vchiq_callback)(enum vchiq_reason,
  65                                             struct vchiq_header *,
  66                                             unsigned int, void *);
  67
  68 struct vchiq_service_base {
  69         int fourcc;
  70         vchiq_callback callback;
  71         void *userdata;
  72 };
  73
  74 struct vchiq_service_params {
  75         int fourcc;
  76         vchiq_callback callback;
  77         void *userdata;
  78         short version;       /* Increment for non-trivial changes */
  79         short version_min;   /* Update for incompatible changes */
  80 };
  81
  82 struct vchiq_config {
  83         unsigned int max_msg_size;
  84         unsigned int bulk_threshold; /* The message size above which it
  85                                         is better to use a bulk transfer
  86                                         (<= max_msg_size) */
  87         unsigned int max_outstanding_bulks;
  88         unsigned int max_services;
  89         short version;      /* The version of VCHIQ */
  90         short version_min;  /* The minimum compatible version of VCHIQ */
  91 };
  92
  93 struct vchiq_instance;
  94 typedef void (*vchiq_remote_callback)(void *cb_arg);
  95
  96 extern enum vchiq_status vchiq_initialise(struct vchiq_instance **pinstance);
  97 extern enum vchiq_status vchiq_shutdown(struct vchiq_instance *instance);
  98 extern enum vchiq_status vchiq_connect(struct vchiq_instance *instance);
  99 extern enum vchiq_status vchiq_add_service(struct vchiq_instance *instance,
 100         const struct vchiq_service_params *params,
 101         unsigned int *pservice);
 102 extern enum vchiq_status vchiq_open_service(struct vchiq_instance *instance,
 103         const struct vchiq_service_params *params,
 104         unsigned int *pservice);
 105 extern enum vchiq_status vchiq_close_service(unsigned int service);
 106 extern enum vchiq_status vchiq_remove_service(unsigned int service);
 107 extern enum vchiq_status vchiq_use_service(unsigned int service);
 108 extern enum vchiq_status vchiq_release_service(unsigned int service);
 109 extern enum vchiq_status
 110 vchiq_queue_message(unsigned int handle,
 111                     ssize_t (*copy_callback)(void *context, void *dest,
 112                                              size_t offset, size_t maxsize),
 113                     void *context,
 114                     size_t size);
 115 extern void           vchiq_release_message(unsigned int service,
 116         struct vchiq_header *header);
 117 extern enum vchiq_status vchiq_bulk_transmit(unsigned int service,
 118         const void *data, unsigned int size, void *userdata,
 119         enum vchiq_bulk_mode mode);
 120 extern enum vchiq_status vchiq_bulk_receive(unsigned int service,
 121         void *data, unsigned int size, void *userdata,
 122         enum vchiq_bulk_mode mode);
 123 extern enum vchiq_status vchiq_bulk_transmit_handle(unsigned int service,
 124         const void *offset, unsigned int size,
 125         void *userdata, enum vchiq_bulk_mode mode);
 126 extern enum vchiq_status vchiq_bulk_receive_handle(unsigned int service,
 127         void *offset, unsigned int size, void *userdata,
 128         enum vchiq_bulk_mode mode);
 129 extern int   vchiq_get_client_id(unsigned int service);
 130 extern void *vchiq_get_service_userdata(unsigned int service);
 131 extern int   vchiq_get_service_fourcc(unsigned int service);
 132 extern void vchiq_get_config(struct vchiq_config *config);
 133 extern enum vchiq_status vchiq_set_service_option(unsigned int service,
 134         enum vchiq_service_option option, int value);
 135
 136 extern enum vchiq_status vchiq_remote_use(struct vchiq_instance *instance,
 137         vchiq_remote_callback callback, void *cb_arg);
 138 extern enum vchiq_status vchiq_remote_release(struct vchiq_instance *instance);
 139
 140 extern enum vchiq_status vchiq_dump_phys_mem(unsigned int service,
 141         void *ptr, size_t num_bytes);
 142
 143 extern enum vchiq_status vchiq_get_peer_version(unsigned int handle,
 144       short *peer_version);
 145
 146 #endif /* VCHIQ_IF_H */