bertos/net/pocketcmd.h

   1 /**
   2  * \file
   3  * <!--
   4  * This file is part of BeRTOS.
   5  *
   6  * Bertos is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  * As a special exception, you may use this file as part of a free software
  21  * library without restriction.  Specifically, if other files instantiate
  22  * templates or use macros or inline functions from this file, or you compile
  23  * this file and link it with other files to produce an executable, this
  24  * file does not by itself cause the resulting executable to be covered by
  25  * the GNU General Public License.  This exception does not however
  26  * invalidate any other reasons why the executable file might be covered by
  27  * the GNU General Public License.
  28  *
  29  * Copyright 2007 Develer S.r.l. (http://www.develer.com/)
  30  * -->
  31  *
  32  * \brief pocketBus protocol command layer interface.
  33  *
  34  * \version $Id: pocketcmd.h 20030 2007-12-04 16:16:09Z batt $
  35  *
  36  * \author Francesco Sacchi <batt@develer.com>
  37  *
  38  */
  39
  40 #ifndef NET_POCKETCMD_H
  41 #define NET_POCKETCMD_H
  42
  43 #include "pocketbus.h"
  44 #include <cfg/compiler.h>
  45
  46 #define PKTCMD_NULL 0 ///< pocketBus Null command
  47
  48 #define PKTCMD_REPLY_TIMEOUT 50 ///< Command replay timeout in milliseconds
  49
  50 typedef uint16_t pocketcmd_t; ///< Type for Command IDs
  51
  52 /**
  53  * Header for transmitted pocketBus Commands.
  54  */
  55 typedef struct PocketCmdHdr
  56 {
  57         pocketcmd_t cmd; ///< command ID
  58 } PocketCmdHdr;
  59
  60 /**
  61  * This ensure that endianess convertion functions work on
  62  * the right data size.
  63  * \{
  64  */
  65 STATIC_ASSERT(sizeof(pocketcmd_t) == sizeof(uint16_t));
  66 /*\}*/
  67
  68 /* fwd declaration */
  69 struct PocketCmdCtx;
  70
  71 /**
  72  * pocketBus command message structure.
  73  */
  74 typedef struct PocketCmdMsg
  75 {
  76         struct PocketCmdCtx *cmd_ctx; ///< command context
  77         pocketcmd_t cmd;              ///< command id
  78         pocketbus_len_t len;          ///< optional arg length
  79         const uint8_t *buf;           ///< optional arguments
  80 } PocketCmdMsg;
  81
  82 /**
  83  * Type for command hooks.
  84  */
  85 typedef void (*pocketcmd_hook_t)(struct PocketCmdMsg *cmd_msg);
  86
  87 /**
  88  * Type for lookup function hooks.
  89  */
  90 typedef pocketcmd_hook_t (*pocketcmd_lookup_t)(pocketcmd_t cmd);
  91
  92 /**
  93  * pocketBus context for command layer communications.
  94  */
  95 typedef struct PocketCmdCtx
  96 {
  97         struct PocketBusCtx *bus_ctx; ///< pocketBus context
  98         pocketbus_addr_t addr;        ///< Our address
  99         pocketcmd_lookup_t search;    ///< Lookup function used to search for command callbacks
 100         pocketcmd_t waiting;          ///< The command ID we are waiting for or PKTCMD_NULL.
 101         ticks_t reply_timer;          ///< For waiting_reply
 102 } PocketCmdCtx;
 103
 104 /**
 105  * Set slave address \a addr for pocketBus command layer.
 106  * If we are a slave this is *our* address.
 107  * If we are the master this is the slave address to send messages to.
 108  */
 109 INLINE void pocketcmd_setAddr(struct PocketCmdCtx *ctx, pocketbus_addr_t addr)
 110 {
 111         ctx->addr = addr;
 112 }
 113
 114 void pocketcmd_init(struct PocketCmdCtx *ctx, struct PocketBusCtx *bus_ctx, pocketbus_addr_t addr, pocketcmd_lookup_t search);
 115 void pocketcmd_poll(struct PocketCmdCtx *ctx);
 116 bool pocketcmd_send(struct PocketCmdCtx *ctx, pocketcmd_t cmd, const void *buf, size_t len, bool has_replay);
 117 void pocketcmd_replyNak(struct PocketCmdMsg *msg);
 118 void pocketcmd_replyAck(struct PocketCmdMsg *msg);
 119
 120 /**
 121  * Helper function used by master to send a command to slave \a addr.
 122  */
 123 INLINE bool pocketcmd_masterSend(struct PocketCmdCtx *ctx, pocketbus_addr_t addr, pocketcmd_t cmd, const void *buf, size_t len)
 124 {
 125         pocketcmd_setAddr(ctx, addr);
 126         return pocketcmd_send(ctx, cmd, buf, len, true);
 127 }
 128
 129 /**
 130  * Helper function used by slave to reply to a master command.
 131  */
 132 INLINE bool pocketcmd_slaveReply(struct PocketCmdCtx *ctx, pocketcmd_t cmd, const void *buf, size_t len)
 133 {
 134         return pocketcmd_send(ctx, cmd, buf, len, false);
 135 }
 136
 137
 138 #endif /* NET_POCKETCMD_H */