Abstract Syntax Notation One (ISO 8824, 8825) codec. More...

Functions
err_t	snmp_asn1_dec_type (struct pbuf p, u16_t ofs, u8_t type)
	Retrieves type field from incoming pbuf chain.
err_t	snmp_asn1_dec_length (struct pbuf p, u16_t ofs, u8_t octets_used, u16_t *length)
	Decodes length field from incoming pbuf chain into host length.
err_t	snmp_asn1_dec_u32t (struct pbuf p, u16_t ofs, u16_t len, u32_t value)
	Decodes positive integer (counter, gauge, timeticks) into u32_t.
err_t	snmp_asn1_dec_s32t (struct pbuf p, u16_t ofs, u16_t len, s32_t value)
	Decodes integer into s32_t.
err_t	snmp_asn1_dec_oid (struct pbuf p, u16_t ofs, u16_t len, struct snmp_obj_id oid)
	Decodes object identifier from incoming message into array of s32_t.
err_t	snmp_asn1_dec_raw (struct pbuf p, u16_t ofs, u16_t len, u16_t raw_len, u8_t raw)
	Decodes (copies) raw data (ip-addresses, octet strings, opaque encoding) from incoming message into array.
void	snmp_asn1_enc_length_cnt (u16_t length, u8_t *octets_needed)
	Returns octet count for length.
void	snmp_asn1_enc_u32t_cnt (u32_t value, u16_t *octets_needed)
	Returns octet count for an u32_t.
void	snmp_asn1_enc_s32t_cnt (s32_t value, u16_t *octets_needed)
	Returns octet count for an s32_t.
void	snmp_asn1_enc_oid_cnt (u8_t ident_len, s32_t ident, u16_t octets_needed)
	Returns octet count for an object identifier.
err_t	snmp_asn1_enc_type (struct pbuf *p, u16_t ofs, u8_t type)
	Encodes ASN type field into a pbuf chained ASN1 msg.
err_t	snmp_asn1_enc_length (struct pbuf *p, u16_t ofs, u16_t length)
	Encodes host order length field into a pbuf chained ASN1 msg.
err_t	snmp_asn1_enc_u32t (struct pbuf *p, u16_t ofs, u16_t octets_needed, u32_t value)
	Encodes u32_t (counter, gauge, timeticks) into a pbuf chained ASN1 msg.
err_t	snmp_asn1_enc_s32t (struct pbuf *p, u16_t ofs, u16_t octets_needed, s32_t value)
	Encodes s32_t integer into a pbuf chained ASN1 msg.
err_t	snmp_asn1_enc_oid (struct pbuf p, u16_t ofs, u8_t ident_len, s32_t ident)
	Encodes object identifier into a pbuf chained ASN1 msg.
err_t	snmp_asn1_enc_raw (struct pbuf p, u16_t ofs, u16_t raw_len, u8_t raw)
	Encodes raw data (octet string, opaque) into a pbuf chained ASN1 msg.

Detailed Description

Abstract Syntax Notation One (ISO 8824, 8825) codec.

Definition in file snmp_asn1.h.

Function Documentation

err_t snmp_asn1_dec_length	(	struct pbuf *	p,
		u16_t	ofs,
		u8_t *	octets_used,
		u16_t *	length
	)

Decodes length field from incoming pbuf chain into host length.

Parameters:

p	points to a pbuf holding an ASN1 coded length
ofs	points to the offset within the pbuf chain of the ASN1 coded length
octets_used	returns number of octets used by the length code
length	return host order length, upto 64k

Returns:: ERR_OK if successfull, ERR_ARG if we can't (or won't) decode

Definition at line 85 of file asn1_dec.c.

err_t snmp_asn1_dec_oid	(	struct pbuf *	p,
		u16_t	ofs,
		u16_t	len,
		struct snmp_obj_id *	oid
	)

Decodes object identifier from incoming message into array of s32_t.

Parameters:

p	points to a pbuf holding an ASN1 coded object identifier
ofs	points to the offset within the pbuf chain of the ASN1 coded object identifier
len	length of the coded object identifier
oid	return object identifier struct

Returns:: ERR_OK if successfull, ERR_ARG if we can't (or won't) decode

Definition at line 429 of file asn1_dec.c.

err_t snmp_asn1_dec_raw	(	struct pbuf *	p,
		u16_t	ofs,
		u16_t	len,
		u16_t	raw_len,
		u8_t *	raw
	)

Decodes (copies) raw data (ip-addresses, octet strings, opaque encoding) from incoming message into array.

Parameters:

p	points to a pbuf holding an ASN1 coded raw data
ofs	points to the offset within the pbuf chain of the ASN1 coded raw data
len	length of the coded raw data (zero is valid, e.g. empty string!)
raw_len	length of the raw return value
raw	return raw bytes

Returns:: ERR_OK if successfull, ERR_ARG if we can't (or won't) decode

Definition at line 596 of file asn1_dec.c.

err_t snmp_asn1_dec_s32t	(	struct pbuf *	p,
		u16_t	ofs,
		u16_t	len,
		s32_t *	value
	)

Decodes integer into s32_t.

Parameters:

p	points to a pbuf holding an ASN1 coded integer
ofs	points to the offset within the pbuf chain of the ASN1 coded integer
len	length of the coded integer field
value	return host order integer

Returns:: ERR_OK if successfull, ERR_ARG if we can't (or won't) decode

Note:: ASN coded integers are _always_ signed!

Definition at line 333 of file asn1_dec.c.

err_t snmp_asn1_dec_type	(	struct pbuf *	p,
		u16_t	ofs,
		u8_t *	type
	)

Retrieves type field from incoming pbuf chain.

Parameters:

p	points to a pbuf holding an ASN1 coded type field
ofs	points to the offset within the pbuf chain of the ASN1 coded type field
type	return ASN1 type

Returns:: ERR_OK if successfull, ERR_ARG if we can't (or won't) decode

Definition at line 52 of file asn1_dec.c.

err_t snmp_asn1_dec_u32t	(	struct pbuf *	p,
		u16_t	ofs,
		u16_t	len,
		u32_t *	value
	)

Decodes positive integer (counter, gauge, timeticks) into u32_t.

Parameters:

p	points to a pbuf holding an ASN1 coded integer
ofs	points to the offset within the pbuf chain of the ASN1 coded integer
len	length of the coded integer field
value	return host order integer

Returns:: ERR_OK if successfull, ERR_ARG if we can't (or won't) decode

Note:: ASN coded integers are _always_ signed. E.g. +0xFFFF is coded as 0x00,0xFF,0xFF. Note the leading sign octet. A positive value of 0xFFFFFFFF is preceded with 0x00 and the length is 5 octets!!

Definition at line 240 of file asn1_dec.c.

err_t snmp_asn1_enc_length	(	struct pbuf *	p,
		u16_t	ofs,
		u16_t	length
	)

Encodes host order length field into a pbuf chained ASN1 msg.

Parameters:

p	points to output pbuf to encode length into
ofs	points to the offset within the pbuf chain
length	is the host order length to be encoded

Returns:: ERR_OK if successfull, ERR_ARG if we can't (or won't) encode

Definition at line 213 of file asn1_enc.c.

void snmp_asn1_enc_length_cnt	(	u16_t	length,
		u8_t *	octets_needed
	)

Returns octet count for length.

Parameters:

length
octets_needed	points to the return value

Definition at line 50 of file asn1_enc.c.

err_t snmp_asn1_enc_oid	(	struct pbuf *	p,
		u16_t	ofs,
		u8_t	ident_len,
		s32_t *	ident
	)

Encodes object identifier into a pbuf chained ASN1 msg.

Parameters:

p	points to output pbuf to encode oid into
ofs	points to the offset within the pbuf chain
ident_len	object identifier array length
ident	points to object identifier array

Returns:: ERR_OK if successfull, ERR_ARG if we can't (or won't) encode

Definition at line 438 of file asn1_enc.c.

void snmp_asn1_enc_oid_cnt	(	u8_t	ident_len,
		s32_t *	ident,
		u16_t *	octets_needed
	)

Returns octet count for an object identifier.

Parameters:

ident_len	object identifier array length
ident	points to object identifier array
octets_needed	points to the return value

Definition at line 142 of file asn1_enc.c.

err_t snmp_asn1_enc_raw	(	struct pbuf *	p,
		u16_t	ofs,
		u16_t	raw_len,
		u8_t *	raw
	)

Encodes raw data (octet string, opaque) into a pbuf chained ASN1 msg.

Parameters:

p	points to output pbuf to encode raw data into
ofs	points to the offset within the pbuf chain
raw_len	raw data length
raw	points raw data

Returns:: ERR_OK if successfull, ERR_ARG if we can't (or won't) encode

Definition at line 562 of file asn1_enc.c.

err_t snmp_asn1_enc_s32t	(	struct pbuf *	p,
		u16_t	ofs,
		u16_t	octets_needed,
		s32_t	value
	)

Encodes s32_t integer into a pbuf chained ASN1 msg.

Parameters:

p	points to output pbuf to encode value into
ofs	points to the offset within the pbuf chain
octets_needed	encoding length (from snmp_asn1_enc_s32t_cnt())
value	is the host order s32_t value to be encoded

Returns:: ERR_OK if successfull, ERR_ARG if we can't (or won't) encode

See also:: snmp_asn1_enc_s32t_cnt()

Definition at line 384 of file asn1_enc.c.

void snmp_asn1_enc_s32t_cnt	(	s32_t	value,
		u16_t *	octets_needed
	)

Returns octet count for an s32_t.

Parameters:

value
octets_needed	points to the return value

Note:: ASN coded integers are _always_ signed.

Definition at line 110 of file asn1_enc.c.

err_t snmp_asn1_enc_type	(	struct pbuf *	p,
		u16_t	ofs,
		u8_t	type
	)

Encodes ASN type field into a pbuf chained ASN1 msg.

Parameters:

p	points to output pbuf to encode value into
ofs	points to the offset within the pbuf chain
type	input ASN1 type

Returns:: ERR_OK if successfull, ERR_ARG if we can't (or won't) encode

Definition at line 181 of file asn1_enc.c.

err_t snmp_asn1_enc_u32t	(	struct pbuf *	p,
		u16_t	ofs,
		u16_t	octets_needed,
		u32_t	value
	)

Encodes u32_t (counter, gauge, timeticks) into a pbuf chained ASN1 msg.

Parameters:

p	points to output pbuf to encode value into
ofs	points to the offset within the pbuf chain
octets_needed	encoding length (from snmp_asn1_enc_u32t_cnt())
value	is the host order u32_t value to be encoded

Returns:: ERR_OK if successfull, ERR_ARG if we can't (or won't) encode

See also:: snmp_asn1_enc_u32t_cnt()

Definition at line 308 of file asn1_enc.c.

void snmp_asn1_enc_u32t_cnt	(	u32_t	value,
		u16_t *	octets_needed
	)

Returns octet count for an u32_t.

Parameters:

value
octets_needed	points to the return value

Note:: ASN coded integers are _always_ signed. E.g. +0xFFFF is coded as 0x00,0xFF,0xFF. Note the leading sign octet. A positive value of 0xFFFFFFFF is preceded with 0x00 and the length is 5 octets!!

Definition at line 77 of file asn1_enc.c.

Type:	Library
Created:	07 Sep 2013
Imports:	19
Forks:	0
Commits:	2
Dependents:	0
Dependencies:	0
Followers:	1

snmp_asn1.h File Reference

Functions

Detailed Description

Function Documentation

Repository toolbox

Repository details

Important Information for this Arm website

snmp_asn1.h File Reference

Functions

Detailed Description

Function Documentation

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning