| /* |
| * Copyright (c) 2013 TRUSTONIC LIMITED |
| * All rights reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions are met: |
| * |
| * 1. Redistributions of source code must retain the above copyright notice, |
| * this list of conditions and the following disclaimer. |
| * |
| * 2. 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. |
| * |
| * 3. Neither the name of the TRUSTONIC LIMITED 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. |
| */ |
| |
| /** |
| * @file dci.h |
| * @brief Contains DCI (Driver Control |
| * Interface) definitions and data structures |
| * |
| */ |
| |
| #ifndef __DCI_H__ |
| #define __DCI_H__ |
| |
| |
| typedef uint32_t dciCommandId_t; |
| typedef uint32_t dciResponseId_t; |
| typedef uint32_t dciReturnCode_t; |
| |
| /**< Responses have bit 31 set */ |
| #define RSP_ID_MASK (1U << 31) |
| #define RSP_ID(cmdId) (((uint32_t)(cmdId)) | RSP_ID_MASK) |
| #define IS_CMD(cmdId) ((((uint32_t)(cmdId)) & RSP_ID_MASK) == 0) |
| #define IS_RSP(cmdId) ((((uint32_t)(cmdId)) & RSP_ID_MASK) == RSP_ID_MASK) |
| |
| /** |
| * Return codes of driver commands. |
| */ |
| #define RET_OK 0 |
| #define RET_ERR_UNKNOWN_CMD 1 |
| #define RET_ERR_NOT_SUPPORTED 2 |
| #define RET_ERR_INTERNAL_ERROR 3 |
| /* ... add more error codes when needed */ |
| |
| /** |
| * DCI command header. |
| */ |
| typedef struct{ |
| dciCommandId_t commandId; /**< Command ID */ |
| } dciCommandHeader_t; |
| |
| /** |
| * DCI response header. |
| */ |
| typedef struct{ |
| dciResponseId_t responseId; /**< Response ID (must be command ID | RSP_ID_MASK )*/ |
| dciReturnCode_t returnCode; /**< Return code of command */ |
| } dciResponseHeader_t; |
| |
| #endif // __DCI_H__ |