apps/shell/shell-rime.h

   1 /*
   2  * Copyright (c) 2008, Swedish Institute of Computer Science.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. Neither the name of the Institute nor the names of its contributors
  14  *    may be used to endorse or promote products derived from this software
  15  *    without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  *
  29  * This file is part of the Contiki operating system.
  30  *
  31  * $Id: shell-rime.h,v 1.7 2010/09/13 13:29:30 adamdunkels Exp $
  32  */
  33
  34 /**
  35  * \file
  36  *         A brief description of what this file is.
  37  * \author
  38  *         Adam Dunkels <adam@sics.se>
  39  */
  40
  41 #ifndef __SHELL_RIME_H__
  42 #define __SHELL_RIME_H__
  43
  44 #include "shell.h"
  45
  46 void shell_rime_init(void);
  47
  48 /* Rime channel used by the 'unicast' debug command, which uses 1 channel */
  49 #define SHELL_RIME_CHANNEL_UNICAST   20
  50
  51 /* Rime channel used by the 'runicast' debug command, which uses 1 channel */
  52 #define SHELL_RIME_CHANNEL_RUNICAST  SHELL_RIME_CHANNEL_UNICAST + 1
  53
  54 /* Rime channel used by the 'broadcast' debug command, which uses 1 channel */
  55 #define SHELL_RIME_CHANNEL_BROADCAST SHELL_RIME_CHANNEL_RUNICAST + 1
  56
  57 /* Rime channel used by the 'nodes' command, which uses 1 channel */
  58 #define SHELL_RIME_CHANNEL_NODES     SHELL_RIME_CHANNEL_BROADCAST + 1
  59
  60 /* Rime channel used by the 'collect' command, which uses 2 channels */
  61 #define SHELL_RIME_CHANNEL_COLLECT   SHELL_RIME_CHANNEL_NODES + 1
  62
  63 /* Rime channel used by the 'ping' command, which uses 3 channels */
  64 #define SHELL_RIME_CHANNEL_PING      SHELL_RIME_CHANNEL_COLLECT + 2
  65
  66 /* Rime channel used by the 'netcmd' command, which uses 1 channels */
  67 #define SHELL_RIME_CHANNEL_NETCMD    SHELL_RIME_CHANNEL_PING + 3
  68
  69 /* Rime channel used by the 'sendcmd' command, which uses 1 channels */
  70 #define SHELL_RIME_CHANNEL_SENDCMD   SHELL_RIME_CHANNEL_NETCMD + 1
  71
  72 /* Rime channel used by the 'netfile' command, which uses 2 channels */
  73 #define SHELL_RIME_CHANNEL_NETFILE   SHELL_RIME_CHANNEL_SENDCMD + 1
  74
  75 /* Rime channel used by the 'sendtest' command, which uses 1 channels */
  76 #define SHELL_RIME_CHANNEL_SENDTEST  SHELL_RIME_CHANNEL_NETFILE + 2
  77
  78 /* Rime channel used by the 'download' command, which uses 2 channels */
  79 #define SHELL_RIME_CHANNEL_DOWNLOAD  SHELL_RIME_CHANNEL_SENDTEST + 1
  80
  81 /* Rime channel used by the 'netperf' command, which uses 6 channels */
  82 #define SHELL_RIME_CHANNEL_NETPERF   SHELL_RIME_CHANNEL_DOWNLOAD + 2
  83
  84
  85 /* Announcement idenfied used by the 'neighbors' command, uses one idenfier */
  86 #define SHELL_RIME_ANNOUNCEMENT_IDENTIFIER_NEIGHBORS SHELL_RIME_CHANNEL_DOWNLOAD + 2
  87
  88 extern struct collect_conn shell_collect_conn;
  89
  90 #endif /* __SHELL_RIME_H__ */