Contiki-NG
shell-commands.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017, Inria.
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  */
32 
33 /**
34  * \file
35  * Main header file for the Contiki shell
36  * \author
37  * Simon Duquennoy <simon.duquennoy@inria.fr>
38  */
39 
40 /** \addtogroup shell
41  * @{ */
42 
43 #ifndef _SHELL_COMMANDS_H_
44 #define _SHELL_COMMANDS_H_
45 
46 /* Command handling function type */
47 typedef char (shell_commands_func)(struct pt *pt, shell_output_func output, char *args);
48 
49 /* Command structure */
50 struct shell_command_t {
51  const char *name;
52  shell_commands_func *func;
53  const char *help;
54 };
55 
56 struct shell_command_set_t {
57  struct shell_command_set_t *next;
58  const struct shell_command_t *const commands;
59 };
60 
61 void shell_command_set_register(struct shell_command_set_t *);
62 int shell_command_set_deregister(struct shell_command_set_t *);
63 const struct shell_command_t *shell_command_lookup(const char *);
64 
65 /**
66  * Initializes Shell-commands module
67  */
68 void shell_commands_init(void);
69 
70 #include "net/mac/tsch/tsch.h"
71 #if TSCH_WITH_SIXTOP
72 typedef void (*shell_command_6top_sub_cmd_t)(shell_output_func output,
73  char *args);
74 void shell_commands_set_6top_sub_cmd(shell_command_6top_sub_cmd_t sub_cmd);
75 #endif /* TSCH_WITH_SIXTOP */
76 
77 #endif /* _SHELL_COMMANDS_H_ */
78 
79 /** @} */
void shell_commands_init(void)
Initializes Shell-commands module.
static uint8_t output(const linkaddr_t *localdest)
Take an IP packet and format it to be sent on an 802.15.4 network using 6lowpan.
Definition: sicslowpan.c:1565
Main API declarations for TSCH.