blob: a1ac7997a44f18ff5aae8df4245cba9d616a164f [file] [log] [blame]
Damjan Marionb4d89272016-05-12 22:14:45 +02001/*
2 * Copyright (c) 2016 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#ifndef included_vnet_optics_sfp_h
17#define included_vnet_optics_sfp_h
18
19#include <vppinfra/format.h>
20
21#define foreach_sfp_id \
22 _ (unknown) \
23 _ (gbic) \
24 _ (on_motherboard) \
25 _ (sfp)
26
Damjan Marion00a9dca2016-08-17 17:05:46 +020027typedef enum
28{
Damjan Marionb4d89272016-05-12 22:14:45 +020029#define _(f) SFP_ID_##f,
30 foreach_sfp_id
31#undef _
32} sfp_id_t;
33
Damjan Marion00a9dca2016-08-17 17:05:46 +020034typedef struct
35{
Damjan Marionb4d89272016-05-12 22:14:45 +020036 u8 id;
37 u8 extended_id;
38 u8 connector_type;
39 u8 compatibility[8];
40 u8 encoding;
41 u8 nominal_bit_rate_100mbits_per_sec;
42 u8 reserved13;
43 u8 link_length[5];
44 u8 reserved19;
45 u8 vendor_name[16];
46 u8 reserved36;
47 u8 vendor_oui[3];
48 u8 vendor_part_number[16];
49 u8 vendor_revision[4];
50 /* 16 bit value network byte order. */
51 u8 laser_wavelength_in_nm[2];
52 u8 reserved62;
53 u8 checksum_0_to_62;
54
55 u8 options[2];
56 u8 max_bit_rate_margin_percent;
57 u8 min_bit_rate_margin_percent;
58 u8 vendor_serial_number[16];
59 u8 vendor_date_code[8];
60 u8 reserved92[3];
61 u8 checksum_63_to_94;
62 u8 vendor_specific[32];
63 u8 reserved128[384];
64
65 /* Vendor specific data follows. */
66 u8 vendor_specific1[0];
67} sfp_eeprom_t;
68
69always_inline uword
70sfp_eeprom_is_valid (sfp_eeprom_t * e)
71{
72 int i;
73 u8 sum = 0;
74 for (i = 0; i < 63; i++)
75 sum += ((u8 *) e)[i];
76 return sum == e->checksum_0_to_62;
77}
78
79/* _ (byte_index, bit_index, name) */
80#define foreach_sfp_compatibility \
81 _ (0, 4, 10g_base_sr) \
82 _ (0, 5, 10g_base_lr) \
83 _ (1, 2, oc48_long_reach) \
84 _ (1, 1, oc48_intermediate_reach) \
85 _ (1, 0, oc48_short_reach) \
86 _ (2, 6, oc12_long_reach) \
87 _ (2, 5, oc12_intermediate_reach) \
88 _ (2, 4, oc12_short_reach) \
89 _ (2, 2, oc3_long_reach) \
90 _ (2, 1, oc3_intermediate_reach) \
91 _ (2, 0, oc3_short_reach) \
92 _ (3, 3, 1g_base_t) \
93 _ (3, 2, 1g_base_cx) \
94 _ (3, 1, 1g_base_lx) \
95 _ (3, 0, 1g_base_sx)
96
Damjan Marion00a9dca2016-08-17 17:05:46 +020097typedef enum
98{
Damjan Marionb4d89272016-05-12 22:14:45 +020099#define _(a,b,f) SFP_COMPATIBILITY_##f,
100 foreach_sfp_compatibility
101#undef _
Damjan Marion00a9dca2016-08-17 17:05:46 +0200102 SFP_N_COMPATIBILITY,
Damjan Marionb4d89272016-05-12 22:14:45 +0200103} sfp_compatibility_t;
104
105u32 sfp_is_comatible (sfp_eeprom_t * e, sfp_compatibility_t c);
106
107format_function_t format_sfp_eeprom;
108
109#endif /* included_vnet_optics_sfp_h */
Damjan Marion00a9dca2016-08-17 17:05:46 +0200110
111/*
112 * fd.io coding-style-patch-verification: ON
113 *
114 * Local Variables:
115 * eval: (c-set-style "gnu")
116 * End:
117 */