mirror of
https://github.com/libretro/RetroArch
synced 2025-01-17 19:14:56 +00:00
95 lines
4.3 KiB
C
95 lines
4.3 KiB
C
/*
|
|
Copyright (c) 2012, Broadcom Europe Ltd
|
|
All rights reserved.
|
|
|
|
Redistribution and use in source and binary forms, with or without
|
|
modification, are permitted provided that the following conditions are met:
|
|
* Redistributions of source code must retain the above copyright
|
|
notice, this list of conditions and the following disclaimer.
|
|
* Redistributions in binary form must reproduce the above copyright
|
|
notice, this list of conditions and the following disclaimer in the
|
|
documentation and/or other materials provided with the distribution.
|
|
* Neither the name of the copyright holder nor the
|
|
names of its contributors may be used to endorse or promote products
|
|
derived from this software without specific prior written permission.
|
|
|
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
|
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
|
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY
|
|
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
|
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
|
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
|
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
|
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
|
|
// General command service API
|
|
|
|
#ifndef GENCMD_H
|
|
#define GENCMD_H
|
|
|
|
#include "vchost_platform_config.h"
|
|
#include "interface/vchi/vchi.h"
|
|
|
|
VCHPRE_ void VCHPOST_ vc_vchi_gencmd_init(VCHI_INSTANCE_T initialise_instance, VCHI_CONNECTION_T **connections, uint32_t num_connections );
|
|
|
|
/* Initialise general command service. Returns it's interface number. This initialises
|
|
the host side of the interface, it does not send anything to VideoCore. */
|
|
|
|
VCHPRE_ int VCHPOST_ vc_gencmd_init(void);
|
|
|
|
/* Stop the service from being used. */
|
|
|
|
VCHPRE_ void VCHPOST_ vc_gencmd_stop(void);
|
|
|
|
/* Return the service number (-1 if not running). */
|
|
VCHPRE_ int VCHPOST_ vc_gencmd_inum(void);
|
|
|
|
/******************************************************************************
|
|
Send commands to VideoCore.
|
|
These all return 0 for success. They return VC_MSGFIFO_FIFO_FULL if there is
|
|
insufficient space for the whole message in the fifo, and none of the message is
|
|
sent.
|
|
******************************************************************************/
|
|
|
|
/* send command to general command service */
|
|
VCHPRE_ int VCHPOST_ vc_gencmd_send( const char *format, ... );
|
|
|
|
/* get response from general command service */
|
|
VCHPRE_ int VCHPOST_ vc_gencmd_read_response(char *response, int maxlen);
|
|
|
|
/* convenience function to send command and receive the response */
|
|
VCHPRE_ int VCHPOST_ vc_gencmd(char *response, int maxlen, const char *format, ...);
|
|
|
|
/* read part of a response from the general command service */
|
|
VCHPRE_ int VCHPOST_ vc_gencmd_read_response_partial(char *response, int nbytes);
|
|
|
|
/* if reading with vc_gencmd_read_response_partial end response reads with this */
|
|
VCHPRE_ int VCHPOST_ vc_gencmd_close_response_partial(void);
|
|
|
|
/* get state of reading of response */
|
|
VCHPRE_ int VCHPOST_ vc_gencmd_read_partial_state(void);
|
|
|
|
/******************************************************************************
|
|
Utilities to help interpret the responses.
|
|
******************************************************************************/
|
|
|
|
/* Read the value of a property=value type pair from a string (typically VideoCore's
|
|
response to a general command). Return non-zero if found. */
|
|
VCHPRE_ int VCHPOST_ vc_gencmd_string_property(char *text, const char *property, char **value, int *length);
|
|
|
|
/* Read the numeric value of a property=number field from a response string. Return
|
|
non-zero if found. */
|
|
VCHPRE_ int VCHPOST_ vc_gencmd_number_property(char *text, const char *property, int *number);
|
|
|
|
/* Send a command until the desired response is received, the error message is detected, or the timeout */
|
|
VCHPRE_ int VCHPOST_ vc_gencmd_until( char *cmd,
|
|
const char *property,
|
|
char *value,
|
|
const char *error_string,
|
|
int timeout);
|
|
|
|
#endif
|