summaryrefslogtreecommitdiffstats
path: root/net/nmrp.h
blob: 1320ed31b97c9ae3522a6f5aae8f8dcbcfb9ecd4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
/*
 *     Copyright (C) 2008 Delta Networks Inc.
 */

extern void NmrpConfig(void);

extern void NmrpHandler(uchar * pkt, unsigned dest, struct in_addr src_ip,
                        unsigned src, unsigned type);
extern int NmrpState;
extern int NmrpFwUPOption;
extern int NmrpSTUPOption;
extern int NmrpStringTableUpdateCount;
extern int NmrpStringTableUpdateIndex;
extern ulong NmrpAliveTimerStart;
extern ulong NmrpAliveTimerBase;
extern int NmrpAliveTimerTimeout;
extern ulong Nmrp_active_start;
/* NMRP codes */
enum _nmrp_codes_ {
	NMRP_CODE_ADVERTISE = 0x01,
	NMRP_CODE_CONF_REQ = 0x02,
	NMRP_CODE_CONF_ACK = 0x03,
	NMRP_CODE_CLOSE_REQ = 0x04,
	NMRP_CODE_CLOSE_ACK = 0x05,
	NMRP_CODE_KEEP_ALIVE_REQ = 0x06,
	NMRP_CODE_KEEP_ALIVE_ACK = 0x07,
	NMRP_CODE_TFTP_UL_REQ = 0x10
};

/* NMRP option types */
enum _nmrp_option_types_ {
	NMRP_OPT_MAGIC_NO = 0x0001,
	NMRP_OPT_DEV_IP = 0x0002,
	NMRP_OPT_DEV_REGION = 0x0004,
	NMRP_OPT_FW_UP = 0x0101,
	NMRP_OPT_ST_UP = 0x0102,
	NMRP_OPT_FILE_NAME = 0x0181
};

/* NMRP Region value */
enum _nmrp_region_values_ {
	NMRP_REGION_NA = 0x0001,
	NMRP_REGION_WW = 0x0002,
	NMRP_REGION_GR = 0x0003,
	NMRP_REGION_PR = 0x0004,
	NMRP_REGION_RU = 0x0005,
	NMRP_REGION_BZ = 0x0006,
	NMRP_REGION_IN = 0x0007,
	NMRP_REGION_KO = 0x0008,
	NMRP_REGION_JP = 0x0009
};

/*  NMRP REQ max retries */
enum _nmrp_req_max_retries_ {
	NMRP_MAX_RETRY_CONF = 5,
	NMRP_MAX_RETRY_CLOSE = 2,
	NMRP_MAX_RETRY_TFTP_UL = 4
};

/* NMRP timeouts */
enum _nmrp_timeouts_ {
	NMRP_TIMEOUT_REQ = 1,	/* 0.5 sec */
	NMRP_TIMEOUT_LISTEN = 3,	/* 3 sec */
	NMRP_TIMEOUT_ACTIVE = 60,	/* 1 minute */
	NMRP_TIMEOUT_CLOSE = 6,	/* 6 sec */
	NMRP_TIMEOUT_ADVERTISE = 1	/* 0.5 sec */
};

#define HEADER_LEN 0x3a

#define STATE_LISTENING 1
#define STATE_CONFIGING 2
#define STATE_TFTPWAITING 3
#define STATE_TFTPUPLOADING 4
#define STATE_CLOSING 5
#define STATE_CLOSED 6
#define STATE_KEEP_ALIVE 7
#define NMRP_HEADER_LEN 6
#define NMRP_OPT_HEADER_LEN 4
#define MAGICNO "NTGR"
#define IP_LEN 4
#define MAGIC_NO_LEN 4
#define DEV_REGION_LEN 2
#define FIRMWARE_FILENAME "firmware"
#define FIRMWARE_FILENAME_LEN 8
#define FIRMWARE_FILENAME_OPT_LEN (NMRP_OPT_HEADER_LEN + FIRMWARE_FILENAME_LEN)
#define STRING_TABLE_BITMASK_LEN 32
#define STRING_TABLE_NUMBER_MAX STRING_TABLE_BITMASK_LEN
#define STRING_TABLE_FILENAME_PREFIX "string table "
#define STRING_TABLE_FILENAME_PREFIX_LEN 13
#define STRING_TABLE_FILENAME_EXAMPLE "string table 01"
#define STRING_TABLE_FILENAME_LEN (STRING_TABLE_FILENAME_PREFIX_LEN + 2)
#define STRING_TABLE_FILENAME_OPT_LEN (NMRP_OPT_HEADER_LEN + STRING_TABLE_FILENAME_LEN)

#define NMRP_MAX_OPT_PER_MSG 6
typedef struct {
	ushort type;
	ushort len;
	union {
		uchar magicno[MAGIC_NO_LEN];
		struct{
			uchar addr[IP_LEN];
			uchar mask[IP_LEN];
		}ip;
		u16 region;
		u32 string_table_bitmask;
	} value;
}__attribute__ ((packed)) NMRP_PARSED_OPT;

typedef struct {
	ushort reserved;
	uchar code;
	uchar id;
	ushort length;
	int numOptions;
	NMRP_PARSED_OPT options[NMRP_MAX_OPT_PER_MSG];
}__attribute__ ((packed)) NMRP_PARSED_MSG;