SNMP.h - Microchip TCP/IP Stack Documentation

SNMP Defs for Microchip TCP/IP Stack

*

*******************************************************************

FileName: SNMP.h
Dependencies: StackTsk.h
UDP.h
Processor: PIC18, PIC24F, PIC24H, dsPIC30F, dsPIC33F, PIC32
Compiler: Microchip C32 v1.05 or higher
Microchip C30 v3.12 or higher
Microchip C18 v3.30 or higher
HI-TECH PICC-18 PRO 9.63PL2 or higher
Company: Microchip Technology, Inc.

*

Software License Agreement

*

Copyright (C) 2002-2009 Microchip Technology Inc. All rights
reserved.

*

Microchip licenses to you the right to use, modify, copy, and
distribute:
(i) the Software when embedded on a Microchip microcontroller or
digital signal controller product ("Device") which is
integrated into Licensee's product; or
(ii) ONLY the Software driver source files ENC28J60.c, ENC28J60.h,
ENCX24J600.c and ENCX24J600.h ported to a non-Microchip device
used in conjunction with a Microchip ethernet controller for
the sole purpose of interfacing with the ethernet controller.

*

You should refer to the license agreement accompanying this
Software for additional information regarding your rights and
obligations.

*

THE SOFTWARE AND DOCUMENTATION ARE PROVIDED "AS IS" WITHOUT
WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT
LIMITATION, ANY WARRANTY OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT SHALL
MICROCHIP BE LIABLE FOR ANY INCIDENTAL, SPECIAL, INDIRECT OR
CONSEQUENTIAL DAMAGES, LOST PROFITS OR LOST DATA, COST OF
PROCUREMENT OF SUBSTITUTE GOODS, TECHNOLOGY OR SERVICES, ANY CLAIMS
BY THIRD PARTIES (INCLUDING BUT NOT LIMITED TO ANY DEFENSE
THEREOF), ANY CLAIMS FOR INDEMNITY OR CONTRIBUTION, OR OTHER
SIMILAR COSTS, WHETHER ASSERTED ON THE BASIS OF CONTRACT, TORT
(INCLUDING NEGLIGENCE), BREACH OF WARRANTY, OR OTHERWISE.

*

V5.36 ---- STACK_USE_MPFS has been removed

	Name	Description
	COMMUNITY_TYPE	This is type COMMUNITY_TYPE.
	DATA_TYPE
	GENERIC_TRAP_NOTIFICATION_TYPE	This is type GENERIC_TRAP_NOTIFICATION_TYPE.
	INOUT_SNMP_PDU	This is type INOUT_SNMP_PDU.
	SNMP_ACTION	This is the list of SNMP action a remote NMS can perform. This inforamtion is passed to application via callback SNMPValidateCommunity(). Application should validate the action for given community string.
	SNMP_ERR_STATUS
	VENDOR_SPECIFIC_TRAP_NOTIFICATION_TYPE	This is type VENDOR_SPECIFIC_TRAP_NOTIFICATION_TYPE.

	Name	Description
	_SNMPDuplexInit	Prepare for full duplex transfer.
	_SNMPGet	Read byte from snmp udp socket rx buffer.
	_SNMPPut	Copy byte to tx buffer.
	GetDataTypeInfo	Get ASN data type info.
	GetNextLeaf	Searches for the next leaf node in the MIP tree.
	GetOIDStringByAddr	Get OID string from MPFS using the node address.
	GetOIDStringByID	Get complete notification variable OID string from MPFS using var id.
	getSnmpV2GenTrapOid	Resolves generic trap code to generic trap OID.
	IsValidInt	Verifies variable datatype as INT and retrieves its value.
	IsValidLength	Retrieves the packet length and actual pdu length.
	IsValidStructure	Decode variable length structure.
	OIDLookup	To search and validate whether the requested OID is in the MIB database.
	ProcessGetBulkVar	This routine process the SNMPv2c Get Bulk Request.
	ProcessGetNextVar	Retrieves next node from the MIB database.
	ProcessGetVar	Processes snmp Get request pdu.
	ProcessSetVar	Processes snmp Set request pdu.
	ProcessSnmpv3MsgData	This routine processes the snmpv3 request and parallely creates the response pdu.
	SetErrorStatus	Set snmp error status in the response pdu.
	SNMPGetExactIndex	To search for exact index node in case of a Sequence variable.
	SNMPGetNextIndex	To search for next index node in case of a Sequence variable.
	SNMPGetTrapTime	Returns trap resolve get time.
	SNMPGetVar	Used to Get/collect OID variable information.
	SNMPIdRecrdValidation	Used to Restrict the access dynamic and non dynamic OID string for A perticular SNMP Version.
	SNMPInit	Initialize SNMP module internals.
	SNMPIsNotifyReady	Resolves given remoteHost IP address into MAC address.
	SNMPIsValidSetLen	Validates the set variable data length to data type.
	SNMPNotify	Creates and Sends TRAP pdu.
	SNMPNotifyPrepare	Collects trap notification info and send ARP to remote host.
	SNMPSendTrap	Prepare, validate remote node which will receive trap and send trap pdu.
	SNMPSetVar	This routine Set the mib variable with the requested value.
	SNMPTask	Polls for every snmp pdu received.
	Snmpv3AESDecryptRxedScopedPdu	Incoming SNMPv3 scoped PDU decryption using AES decryption protocol.
	Snmpv3BufferPut	Copies BYTE data to dynamically allocated memory buffer.
	Snmpv3FormulateEngineID	Formulates the snmpEngineID for the SNMPV3 engine.
	Snmpv3GetAuthEngineTime	Updates the snmp engine time variable 'snmpEngineTime' for the SNMPV3 engine.
	Snmpv3GetBufferData	Reads BYTE data from dynamically allocated memory buffer.
	Snmpv3MsgProcessingModelProcessPDU	This routine collects or populates the message processing model infomation from the received SNMPv3 request PDU or to the response PDU respectively.
	Snmpv3Notify	Creates and Sends SNMPv3 TRAP pdu.
	Snmpv3ScopedPduProcessing	This routine collects the scoped pdu header information from the received SNMPv3 request PDU or populates to the response PDU respectively.
	Snmpv3TrapScopedpdu	TRAP PDU scoped pdu header construction.
	Snmpv3UserSecurityModelProcessPDU	This routine collects or populates the security model parametrs infomation from the received SNMPv3 request PDU or to the response PDU respectively.
	Snmpv3UsmAesEncryptDecryptInitVector	AES Encryption and decryption init vector.(RFC 3826 )
	Snmpv3UsmOutMsgAuthenticationParam	Both MD5 and SHA1 is used for the outgoing message authentication.
	Snmpv3ValidateEngineId	Validate engine ID.
	Snmpv3ValidateSecNameAndSecLvl	Vaidate security name with Security level.
	Snmpv3ValidateSecurityName	Validate SNMPV3 user name or security name.
	SNMPValidateCommunity	Validates community name for access control.

	Name	Description
	_SNMPGetTxOffset	This is macro _SNMPGetTxOffset.
	_SNMPSetTxOffset
	AGENT_NOTIFY_PORT	This is macro AGENT_NOTIFY_PORT.
	ASN_INT	This is macro ASN_INT.
	ASN_NULL	This is macro ASN_NULL.
	ASN_OID	This is macro ASN_OID.
	DATA_TYPE_TABLE_SIZE
	GET_BULK_REQUEST	This is macro GET_BULK_REQUEST.
	GET_NEXT_REQUEST	This is macro GET_NEXT_REQUEST.
	GET_REQUEST
	GET_RESPONSE	This is macro GET_RESPONSE.
	IS_AGENT_PDU	This is macro IS_AGENT_PDU.
	IS_ASN_INT	This is macro IS_ASN_INT.
	IS_ASN_NULL	This is macro IS_ASN_NULL.
	IS_GET_NEXT_REQUEST	This is macro IS_GET_NEXT_REQUEST.
	IS_GET_REQUEST	This is macro IS_GET_REQUEST.
	IS_GET_RESPONSE	This is macro IS_GET_RESPONSE.
	IS_OCTET_STRING	This is macro IS_OCTET_STRING.
	IS_OID	This is macro IS_OID.
	IS_SET_REQUEST	This is macro IS_SET_REQUEST.
	IS_SNMPV3_AUTH_STRUCTURE	This is macro IS_SNMPV3_AUTH_STRUCTURE.
	IS_STRUCTURE
	IS_TRAP	This is macro IS_TRAP.
	OCTET_STRING	This is macro OCTET_STRING.
	OID_MAX_LEN	Change this to match your OID string length.
	REPORT_RESPONSE	This is macro REPORT_RESPONSE.
	SET_REQUEST	This is macro SET_REQUEST.
	SNMP_AGENT_PORT
	SNMP_BIB_FILE_NAME	This is the file that contains SNMP bib file. File name must contain all upper case letter and must match with what was included in MPFS2 image.
	SNMP_COUNTER32	This is macro SNMP_COUNTER32.
	SNMP_END_OF_VAR	This is macro SNMP_END_OF_VAR.
	SNMP_GAUGE32	This is macro SNMP_GAUGE32.
	SNMP_INDEX_INVALID	This is macro SNMP_INDEX_INVALID.
	SNMP_IP_ADDR	This is macro SNMP_IP_ADDR.
	SNMP_MAX_MSG_SIZE	SNMP MIN and MAX message 484 bytes in size As per RFC 3411 snmpEngineMaxMessageSize and RFC 1157 ( section 4- protocol specification ) and implementation supports more than 484 whenever feasible.
	SNMP_MAX_OID_LEN_MEM_USE	This macro will be used to avoid SNMP OID memory buffer corruption
	SNMP_NMS_PORT	This is macro SNMP_NMS_PORT.
	SNMP_NSAP_ADDR	This is macro SNMP_NSAP_ADDR.
	SNMP_OPAQUE	This is macro SNMP_OPAQUE.
	SNMP_START_OF_VAR	This is macro SNMP_START_OF_VAR.
	SNMP_TIME_TICKS	This is macro SNMP_TIME_TICKS.
	SNMP_TRAP_COMMUNITY_MAX_LEN_MEM_USE	This macro will be used to avoid SNMP OID memory buffer corruption
	SNMP_V1
	SNMP_V2C	This is macro SNMP_V2C.
	SNMP_V3	This is macro SNMP_V3.
	STRUCTURE
	TRAP	This is macro TRAP.
	TRAP_COMMUNITY_MAX_LEN	This is macro TRAP_COMMUNITY_MAX_LEN.
	TRAP_TABLE_SIZE	This is macro TRAP_TABLE_SIZE.

	Name	Description
	DATA_TYPE_INFO
	OID_INFO
	PDU_INFO
	reqVarErrStatus
	SNMP_NOTIFY_INFO
	SNMPNONMIBRECDINFO	This is type SNMPNONMIBRECDINFO.
	SNMPV3MSGDATA	SNMPv3
	TRAP_INFO	This is type TRAP_INFO.

	Name	Description
	SNMP_ID	This is the SNMP OID variable id. This id is assigned via MIB file. Only dynamic and AgentID variables can contian ID. MIB2BIB utility enforces this rules when BIB was generated.
	SNMP_INDEX	This is type SNMP_INDEX.

	Name	Description
	INDEX_INFO
	MIB_INFO
	SNMP_STATUS
	SNMP_VAL	This is type SNMP_VAL.