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 command abstraction layer.
  33  *
  34  * \version $Id$
  35  *
  36  * \author Francesco Sacchi <batt@develer.com>
  37  *
  38  * $WIZ$ module_name = "pocketcmd"
  39  * $WIZ$ module_depends = "timer", "pocketbus"
  40  */
  41
  42 #ifndef NET_POCKETCMD_H
  43 #define NET_POCKETCMD_H
  44
  45 #include "pocketbus.h"
  46 #include <cfg/compiler.h>
  47
  48 #define PKTCMD_NULL 0 ///< pocketBus Null command
  49
  50 #define PKTCMD_REPLY_TIMEOUT 50 ///< Command replay timeout in milliseconds
  51
  52 typedef uint16_t pocketcmd_t; ///< Type for Command IDs
  53
  54 /**
  55  * Header for transmitted pocketBus Commands.
  56  */
  57 typedef struct PocketCmdHdr
  58 {
  59         pocketcmd_t cmd; ///< command ID
  60 } PocketCmdHdr;
  61
  62 /**
  63  * This ensure that endianess convertion functions work on
  64  * the right data size.
  65  * \{
  66  */
  67 STATIC_ASSERT(sizeof(pocketcmd_t) == sizeof(uint16_t));
  68 /*\}*/
  69
  70 /* fwd declaration */
  71 struct PocketCmdCtx;
  72
  73 /**
  74  * pocketBus command message structure.
  75  */
  76 typedef struct PocketCmdMsg
  77 {
  78         struct PocketCmdCtx *cmd_ctx; ///< command context
  79         pocketcmd_t cmd;              ///< command id
  80         pocketbus_len_t len;          ///< optional arg length
  81         const uint8_t *buf;           ///< optional arguments
  82 } PocketCmdMsg;
  83
  84 /**
  85  * Type for command hooks.
  86  */
  87 typedef void (*pocketcmd_hook_t)(struct PocketCmdMsg *cmd_msg);
  88
  89 /**
  90  * Type for lookup function hooks.
  91  */
  92 typedef pocketcmd_hook_t (*pocketcmd_lookup_t)(pocketcmd_t cmd);
  93
  94 /**
  95  * pocketBus context for command layer communications.
  96  */
  97 typedef struct PocketCmdCtx
  98 {
  99         struct PocketBusCtx *bus_ctx; ///< pocketBus context
 100         pocketbus_addr_t addr;        ///< Our address
 101         pocketcmd_lookup_t search;    ///< Lookup function used to search for command callbacks
 102         pocketcmd_t waiting;          ///< The command ID we are waiting for or PKTCMD_NULL.
 103         ticks_t reply_timer;          ///< For waiting_reply
 104 } PocketCmdCtx;
 105
 106 /**
 107  * Set slave address \a addr for pocketBus command layer.
 108  * If we are a slave this is *our* address.
 109  * If we are the master this is the slave address to send messages to.
 110  */
 111 INLINE void pocketcmd_setAddr(struct PocketCmdCtx *ctx, pocketbus_addr_t addr)
 112 {
 113         ctx->addr = addr;
 114 }
 115
 116 void pocketcmd_init(struct PocketCmdCtx *ctx, struct PocketBusCtx *bus_ctx, pocketbus_addr_t addr, pocketcmd_lookup_t search);
 117 void pocketcmd_poll(struct PocketCmdCtx *ctx);
 118 bool pocketcmd_send(struct PocketCmdCtx *ctx, pocketcmd_t cmd, const void *buf, size_t len, bool has_replay);
 119 void pocketcmd_replyNak(struct PocketCmdMsg *msg);
 120 void pocketcmd_replyAck(struct PocketCmdMsg *msg);
 121
 122 /**
 123  * Helper function used by master to send a command to slave \a addr.
 124  */
 125 INLINE bool pocketcmd_masterSend(struct PocketCmdCtx *ctx, pocketbus_addr_t addr, pocketcmd_t cmd, const void *buf, size_t len)
 126 {
 127         pocketcmd_setAddr(ctx, addr);
 128         return pocketcmd_send(ctx, cmd, buf, len, true);
 129 }
 130
 131 /**
 132  * Helper function used by slave to reply to a master command.
 133  */
 134 INLINE bool pocketcmd_slaveReply(struct PocketCmdCtx *ctx, pocketcmd_t cmd, const void *buf, size_t len)
 135 {
 136         return pocketcmd_send(ctx, cmd, buf, len, false);
 137 }
 138
 139
 140 #endif /* NET_POCKETCMD_H */