brlapi_protocol.h

Go to the documentation of this file.

/*
 * libbrlapi - A library providing access to braille terminals for applications.
 *
 * Copyright (C) 2002-2024 by
 *   Samuel Thibault <Samuel.Thibault@ens-lyon.org>
 *   Sébastien Hinderer <Sebastien.Hinderer@ens-lyon.org>
 *
 * libbrlapi comes with ABSOLUTELY NO WARRANTY.
 *
 * This is free software, placed under the terms of the
 * GNU Lesser General Public License, as published by the Free Software
 * Foundation; either version 2.1 of the License, or (at your option) any
 * later version. Please see the file LICENSE-LGPL for details.
 *
 * Web Page: http://brltty.app/
 *
 * This software is maintained by Dave Mielke <dave@mielke.cc>.
 */
 
#ifndef BRLAPI_INCLUDED_PROTOCOL
#define BRLAPI_INCLUDED_PROTOCOL
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
#include "brlapi.h"
 
/* this is for UINT32_MAX */
#include <inttypes.h>
#ifndef UINT32_MAX
#define UINT32_MAX (4294967295U)
#endif /* UINT32_MAX */
 
/* The type size_t is defined there! */
#include <unistd.h>
 
#define BRLAPI_PROTOCOL_VERSION ((uint32_t) 8) 
#define BRLAPI_MAXPACKETSIZE 4096
 
#define BRLAPI_PACKET_VERSION         'v'   
#define BRLAPI_PACKET_AUTH            'a'   
#define BRLAPI_PACKET_GETDRIVERNAME   'n'   
#define BRLAPI_PACKET_GETMODELID      'd'   
#define BRLAPI_PACKET_GETDISPLAYSIZE  's'   
#define BRLAPI_PACKET_ENTERTTYMODE    't'   
#define BRLAPI_PACKET_SETFOCUS        'F'   
#define BRLAPI_PACKET_LEAVETTYMODE    'L'   
#define BRLAPI_PACKET_KEY             'k'   
#define BRLAPI_PACKET_IGNOREKEYRANGES 'm'   
#define BRLAPI_PACKET_ACCEPTKEYRANGES 'u'   
#define BRLAPI_PACKET_WRITE           'w'   
#define BRLAPI_PACKET_ENTERRAWMODE    '*'   
#define BRLAPI_PACKET_LEAVERAWMODE    '#'   
#define BRLAPI_PACKET_PACKET          'p'   
#define BRLAPI_PACKET_ACK             'A'   
#define BRLAPI_PACKET_ERROR           'e'   
#define BRLAPI_PACKET_EXCEPTION       'E'   
#define BRLAPI_PACKET_SUSPENDDRIVER   'S'   
#define BRLAPI_PACKET_RESUMEDRIVER    'R'   
#define BRLAPI_PACKET_SYNCHRONIZE     'Z'   
#define BRLAPI_PACKET_PARAM_VALUE     (('P'<<8) + 'V') 
#define BRLAPI_PACKET_PARAM_REQUEST   (('P'<<8) + 'R') 
#define BRLAPI_PACKET_PARAM_UPDATE    (('P'<<8) + 'U') 
#define BRLAPI_DEVICE_MAGIC (0xdeadbeefL)
 
typedef struct {
  uint32_t size;
  brlapi_packetType_t type;
} brlapi_header_t;
 
#define BRLAPI_HEADERSIZE sizeof(brlapi_header_t)
 
typedef struct {
  uint32_t protocolVersion;
} brlapi_versionPacket_t;
 
typedef struct {
  uint32_t type;
  unsigned char key;
} brlapi_authClientPacket_t;
 
typedef struct {
  uint32_t type[1];
} brlapi_authServerPacket_t;
 
#define BRLAPI_AUTH_NONE 'N' 
#define BRLAPI_AUTH_KEY  'K' 
#define BRLAPI_AUTH_CRED 'C' 
typedef struct {
  uint32_t code;
  brlapi_packetType_t type;
  unsigned char packet;
} brlapi_errorPacket_t;
 
typedef struct {
  uint32_t magic;
  unsigned char nameLength;
  char name;
} brlapi_getDriverSpecificModePacket_t;
 
#define BRLAPI_WF_DISPLAYNUMBER 0X01    
#define BRLAPI_WF_REGION        0X02    
#define BRLAPI_WF_TEXT          0X04    
#define BRLAPI_WF_ATTR_AND      0X08    
#define BRLAPI_WF_ATTR_OR       0X10    
#define BRLAPI_WF_CURSOR        0X20    
#define BRLAPI_WF_CHARSET       0X40    
typedef struct {
  uint32_t flags; 
  unsigned char data; 
} brlapi_writeArgumentsPacket_t;
 
#define BRLAPI_PVF_GLOBAL            0X01    
#define BRLAPI_MAXPARAMSIZE (BRLAPI_MAXPACKETSIZE - (sizeof(uint32_t) + sizeof(brlapi_param_t) + 2*sizeof(uint32_t)))
 
typedef struct {
  uint32_t flags; 
  brlapi_param_t param; 
  uint32_t subparam_hi; 
  uint32_t subparam_lo; 
  unsigned char data[BRLAPI_MAXPARAMSIZE]; 
} brlapi_paramValuePacket_t;
 
#define BRLAPI_PARAMF_GET            0X100    
#define BRLAPI_PARAMF_SUBSCRIBE      0X200    
#define BRLAPI_PARAMF_UNSUBSCRIBE    0X400    
typedef struct {
  uint32_t flags; 
  brlapi_param_t param; 
  uint32_t subparam_hi; 
  uint32_t subparam_lo; 
} brlapi_paramRequestPacket_t;
 
typedef union {
        unsigned char data[BRLAPI_MAXPACKETSIZE];
        brlapi_versionPacket_t version;
        brlapi_authClientPacket_t authClient;
        brlapi_authServerPacket_t authServer;
        brlapi_errorPacket_t error;
        brlapi_getDriverSpecificModePacket_t getDriverSpecificMode;
        brlapi_writeArgumentsPacket_t writeArguments;
        brlapi_paramValuePacket_t paramValue;
        brlapi_paramRequestPacket_t paramRequest;
        uint32_t uint32;
} brlapi_packet_t;
 
/* brlapi_writePacket */
ssize_t brlapi_writePacket(brlapi_fileDescriptor fd, brlapi_packetType_t type, const void *buf, size_t size);
 
/* brlapi_readPacketHeader */
ssize_t brlapi_readPacketHeader(brlapi_fileDescriptor fd, brlapi_packetType_t *packetType);
 
/* brlapi_readPacketContent */
ssize_t brlapi_readPacketContent(brlapi_fileDescriptor fd, size_t packetSize, void *buf, size_t bufSize);
 
/* brlapi_readPacket */
ssize_t brlapi_readPacket(brlapi_fileDescriptor fd, brlapi_packetType_t *type, void *buf, size_t size);
 
/* brlapi_fd_mutex */
#ifdef __MINGW32__
#include <windows.h>
extern HANDLE brlapi_fd_mutex;
#else /* __MINGW32__ */
#include <pthread.h>
extern pthread_mutex_t brlapi_fd_mutex;
#endif /* __MINGW32__ */
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* BRLAPI_INCLUDED_PROTOCOL */