1/*
2 * Copyright (c) 2015 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
6 *
7 *     http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15/*
16 * hdlc.h: types/functions for hdlc.
17 *
18 * Copyright (c) 2008 Eliot Dresselhaus
19 *
20 * Permission is hereby granted, free of charge, to any person obtaining
21 * a copy of this software and associated documentation files (the
22 * "Software"), to deal in the Software without restriction, including
23 * without limitation the rights to use, copy, modify, merge, publish,
24 * distribute, sublicense, and/or sell copies of the Software, and to
25 * permit persons to whom the Software is furnished to do so, subject to
26 * the following conditions:
27 *
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
30 *
31 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
32 *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33 *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
34 *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
35 *  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
36 *  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
37 *  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
38 */
39
40#ifndef included_hdlc_h
41#define included_hdlc_h
42
43#include <vnet/vnet.h>
44#include <vnet/hdlc/packet.h>
45#include <vnet/pg/pg.h>
46
47extern vnet_hw_interface_class_t hdlc_hw_interface_class;
48
49typedef enum
50{
51#define hdlc_error(n,s) HDLC_ERROR_##n,
52#include <vnet/hdlc/error.def>
53#undef hdlc_error
54  HDLC_N_ERROR,
55} hdlc_error_t;
56
57typedef struct
58{
59  /* Name (a c string). */
60  char *name;
61
62  /* HDLC protocol type in host byte order. */
63  hdlc_protocol_t protocol;
64
65  /* Node which handles this type. */
66  u32 node_index;
67
68  /* Next index for this type. */
69  u32 next_index;
70} hdlc_protocol_info_t;
71
72typedef struct
73{
74  vlib_main_t *vlib_main;
75
76  hdlc_protocol_info_t *protocol_infos;
77
78  /* Hash tables mapping name/protocol to protocol info index. */
79  uword *protocol_info_by_name, *protocol_info_by_protocol;
80} hdlc_main_t;
81
82always_inline hdlc_protocol_info_t *
83hdlc_get_protocol_info (hdlc_main_t * em, hdlc_protocol_t protocol)
84{
85  uword *p = hash_get (em->protocol_info_by_protocol, protocol);
86  return p ? vec_elt_at_index (em->protocol_infos, p[0]) : 0;
87}
88
89extern hdlc_main_t hdlc_main;
90
91/* Register given node index to take input for given hdlc type. */
92void
93hdlc_register_input_type (vlib_main_t * vm,
94			  hdlc_protocol_t protocol, u32 node_index);
95
96format_function_t format_hdlc_protocol;
97format_function_t format_hdlc_header;
98format_function_t format_hdlc_header_with_length;
99
100/* Parse hdlc protocol as 0xXXXX or protocol name.
101   In either host or network byte order. */
102unformat_function_t unformat_hdlc_protocol_host_byte_order;
103unformat_function_t unformat_hdlc_protocol_net_byte_order;
104
105/* Parse hdlc header. */
106unformat_function_t unformat_hdlc_header;
107unformat_function_t unformat_pg_hdlc_header;
108
109always_inline void
110hdlc_setup_node (vlib_main_t * vm, u32 node_index)
111{
112  vlib_node_t *n = vlib_get_node (vm, node_index);
113  pg_node_t *pn = pg_get_node (node_index);
114
115  n->format_buffer = format_hdlc_header_with_length;
116  n->unformat_buffer = unformat_hdlc_header;
117  pn->unformat_edit = unformat_pg_hdlc_header;
118}
119
120void
121hdlc_register_input_protocol (vlib_main_t * vm,
122			      hdlc_protocol_t protocol, u32 node_index);
123
124#endif /* included_hdlc_h */
125
126/*
127 * fd.io coding-style-patch-verification: ON
128 *
129 * Local Variables:
130 * eval: (c-set-style "gnu")
131 * End:
132 */
133