/*
 * Copyright (c) 2011-2013, Texas Instruments Incorporated
 * 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 Texas Instruments Incorporated 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 OWNER 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.
 */
/*
 *  ======== rpmsg_omx.h ========
 *
 *  These must match definitions in the Linux rpmsg_omx driver.
 */

#ifndef _RPMSGOMX_H_
#define _RPMSGOMX_H_

/**
 * enum omx_msg_types - various message types currently supported
 *
 * @OMX_CONN_REQ: a connection request message type. the message should carry
 * the name of the OMX service which we try to connect to. An instance of
 * that service will be created remotely, and its address will be sent as
 * a reply.
 *
 * @OMX_CONN_RSP: a response to a connection request. the message will carry
 * an error code (success/failure), and if connection established successfully,
 * the addr field will carry the address of the newly created OMX instance.
 *
 * @OMX_PING_MSG: a ping message. should trigger a pong message as a response,
 * with the same payload the ping had, used for testing purposes.
 *
 * @OMX_PONG_MSG: a response to a ping. should carry the same payload that
 * the ping had. used for testing purposes.
 *
 * @OMX_DISC_REQ: a disconnect request message type. the message should carry
 * the address of the OMX service previously received from the OMX_CONN_RSP
 * message.
 *
 * @OMX_RAW_MSG: a message that should be propagated as-is to the user.
 * this would immediately enable user space development to start.
 * as we progress, most likely this message won't be needed anymore.
 *
 * @OMX_DISC_RSP: a disconnect response message type. the message should carry
 * the status from the OMX_DISC_REQ message.
 */
enum omx_msg_types {
    OMX_CONN_REQ = 0,
    OMX_CONN_RSP = 1,
    OMX_PING_MSG = 2,
    OMX_PONG_MSG = 3,
    OMX_DISC_REQ = 4,
    OMX_RAW_MSG  = 5,
    OMX_DISC_RSP = 6
};

/**
 * enum omx_error_codes - various error codes that will be used
 *
 * @OMX_SUCCESS: success
 *
 * @OMX_NOTSUPP: not supported
 *
 * @OMX_NOMEM: remote processor is out of memory
 *
 * @OMX_FAIL: general failure.
 */
enum omx_error_codes {
    OMX_SUCCESS = 0,
    OMX_NOTSUPP = 1,
    OMX_NOMEM = 2,
    OMX_FAIL  = 3
};

/**
 * struct omx_msg_hdr - common header for all OMX messages
 * @type:type of message, see enum omx_msg_types
 * @flags:currently unused, should be zero
 * @len:length of msg payload (in bytes)
 * @data:the msg payload (depends on the message type)
 *
 * All OMX messages will start with this common header (which will begin
 * right after the standard rpmsg header ends).
 */
struct omx_msg_hdr {
    UInt32 type;
    UInt32 flags;
    UInt32 len;
    Char   data[1];
};

/* define this here because we cannot use data[0] in struct above */
#define HDRSIZE (3 * sizeof(UInt))

struct omx_connect_req {
    Char name[48];
};

struct omx_connect_rsp {
    UInt32 status;
    UInt32 addr;
};

struct omx_disc_req {
    UInt32 addr;
};

struct omx_disc_rsp {
    UInt32 status;
};

#endif