wanpipe_api.h File Reference

WANPIPE(tm) Driver API - Provides FULL Wanpipe Driver API Support Full API includes: Management/Configuration/IO/Events. More...

#include "aft_core_user.h"
#include "wanpipe_api_hdr.h"
#include "wanpipe_api_iface.h"
#include "wanpipe_api_legacy.h"
#include "wanpipe_api_depricated.h"

Include dependency graph for wanpipe_api.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  wan_mgmt
 Wanpipe UDP Management Structure. More...
struct  wan_udp_hdr
 Wanpipe UDP Structure used for Maintenance and Debugging. More...

Defines

#define WP_API_EVENT_SET   0x01
 Option to write a particular command.
#define WP_API_EVENT_GET   0x02
 Option to read a particular command.
#define WP_API_EVENT_ENABLE   0x01
 Option to enable command.
#define WP_API_EVENT_DISABLE   0x02
 Option to disable command.
#define WP_API_EVENT_MODE_DECODE(mode)
 Decode disable/enable command.
#define WP_API_EVENT_RXHOOK_OFF   0x01
#define WP_API_EVENT_RXHOOK_ON   0x02
#define WP_API_EVENT_RING_PRESENT   0x01
#define WP_API_EVENT_RING_STOP   0x02
#define WP_API_EVENT_TONE_DIAL   0x01
#define WP_API_EVENT_TONE_BUSY   0x02
#define WP_API_EVENT_TONE_RING   0x03
#define WP_API_EVENT_TONE_CONGESTION   0x04
#define GLOBAL_UDP_SIGNATURE   "WANPIPE"
#define GLOBAL_UDP_SIGNATURE_LEN   7
#define UDPMGMT_UDP_PROTOCOL   0x11
#define xilinx   aft
#define wan_udphdr_signature   wan_mgmt.signature
#define wan_udphdr_request_reply   wan_mgmt.request_reply
#define wan_udphdr_id   wan_mgmt.id
#define wan_udphdr_opp_flag   wan_cmd.wan_cmd_opp_flag
#define wan_udphdr_command   wan_cmd.wan_cmd_command
#define wan_udphdr_data_len   wan_cmd.wan_cmd_data_len
#define wan_udphdr_return_code   wan_cmd.wan_cmd_return_code
#define wan_udphdr_fe_force   wan_cmd.wan_cmd_fe_force
#define wan_udphdr_hdlc_PF_bit   wan_cmd.wan_cmd_hdlc_PF_bit
#define wan_udphdr_fr_dlci   wan_cmd.wan_cmd_fr_dlci
#define wan_udphdr_fr_attr   wan_cmd.wan_cmd_fr_attr
#define wan_udphdr_fr_rxlost1   wan_cmd.wan_cmd_fr_rxlost1
#define wan_udphdr_fr_rxlost2   wan_cmd.wan_cmd_fr_rxlost2
#define wan_udphdr_x25_pf   wan_cmd.wan_cmd_x25_pf
#define wan_udphdr_x25_lcn   wan_cmd.wan_cmd_x25_lcn
#define wan_udphdr_x25_qdm   wan_cmd.wan_cmd_x25_qdm
#define wan_udphdr_x25_cause   wan_cmd.wan_cmd_x25_cause
#define wan_udphdr_x25_diagn   wan_cmd.wan_cmd_x25_diagn
#define wan_udphdr_x25_pktType   wan_cmd.wan_cmd_x25_pktType
#define wan_udphdr_bscstrm_misc_bits   wan_cmd.wan_cmd_bscstrm_misc_bits
#define wan_udphdr_bscstrm_Rx_err_bits   wan_cmd.wan_cmd_bscstrm_Rx_err_bits
#define wan_udphdr_bscstrm_Rx_time_stamp   wan_cmd.wan_cmd_bscstrm_Rx_time_stamp
#define wan_udphdr_bscstrm_port   wan_cmd.wan_cmd_bscstrm_port
#define wan_udphdr_bsc_misc_bits   wan_cmd.wan_cmd_bsc_misc_bit
#define wan_udphdr_bsc_misc_heading_len   wan_cmd.wan_cmd_bsc_misc_heading_len
#define wan_udphdr_bsc_misc_notify   wan_cmd.wan_cmd_bsc_misc_notify
#define wan_udphdr_bsc_misc_station   wan_cmd.wan_cmd_bsc_misc_station
#define wan_udphdr_bsc_misc_poll_add   wan_cmd.wan_cmd_bsc_misc_poll_addr
#define wan_udphdr_bsc_misc_select_addr   wan_cmd.wan_cmd_bsc_misc_select_addr
#define wan_udphdr_bsc_misc_device_addr   wan_cmd.wan_cmd_bsc_misc_device_addr
#define wan_udphdr_chdlc_num_frames   wan_udphdr_u.chdlc.trace_info.num_frames
#define wan_udphdr_chdlc_ismoredata   wan_udphdr_u.chdlc.trace_info.ismoredata
#define wan_udphdr_chdlc_data   wan_udphdr_u.chdlc.data
#define wan_udphdr_bitstrm_num_frames   wan_udphdr_u.bitstrm.trace_info.num_frames
#define wan_udphdr_bitstrm_ismoredata   wan_udphdr_u.bitstrm.trace_info.ismoredata
#define wan_udphdr_bitstrm_data   wan_udphdr_u.bitstrm.data
#define wan_udphdr_adsl_num_frames   wan_udphdr_u.adsl.trace_info.num_frames
#define wan_udphdr_adsl_ismoredata   wan_udphdr_u.adsl.trace_info.ismoredata
#define wan_udphdr_adsl_data   wan_udphdr_u.adsl.data
#define wan_udphdr_atm_num_frames   wan_udphdr_u.atm.trace_info.num_frames
#define wan_udphdr_atm_ismoredata   wan_udphdr_u.atm.trace_info.ismoredata
#define wan_udphdr_atm_data   wan_udphdr_u.atm.data
#define wan_udphdr_ss7_num_frames   wan_udphdr_u.ss7.trace_info.num_frames
#define wan_udphdr_ss7_ismoredata   wan_udphdr_u.ss7.trace_info.ismoredata
#define wan_udphdr_ss7_data   wan_udphdr_u.ss7.data
#define wan_udphdr_aft_trace_info   wan_udphdr_u.aft.trace_info
#define wan_udphdr_aft_num_frames   wan_udphdr_u.aft.trace_info.num_frames
#define wan_udphdr_aft_ismoredata   wan_udphdr_u.aft.trace_info.ismoredata
#define wan_udphdr_aft_data   wan_udphdr_u.aft.data
#define wan_udphdr_data   wan_udphdr_aft_data
#define WP_PORT_NAME_FORM   "wanpipe%d"
 String define of a wanpipe port name.
#define WP_INTERFACE_NAME_FORM   "wanpipe%d_if%d"
 String define of a wanpipe interface name.

Typedefs

typedef wan_mgmt wan_mgmt_t
typedef wan_udp_hdr wan_udp_hdr_t

Enumerations

enum  wanpipe_aft_devel_events {
  SIOC_WAN_READ_REG = 0x01, SIOC_WAN_WRITE_REG, SIOC_WAN_HWPROBE, SIOC_WAN_ALL_HWPROBE,
  SIOC_WAN_ALL_READ_REG, SIOC_WAN_ALL_WRITE_REG, SIOC_WAN_ALL_SET_PCI_BIOS, SIOC_WAN_SET_PCI_BIOS,
  SIOC_WAN_COREREV, SIOC_WAN_GET_CFG, SIOC_WAN_FE_READ_REG, SIOC_WAN_FE_WRITE_REG,
  SIOC_WAN_EC_REG, SIOC_WAN_READ_PCIBRIDGE_REG, SIOC_WAN_ALL_READ_PCIBRIDGE_REG, SIOC_WAN_WRITE_PCIBRIDGE_REG,
  SIOC_WAN_ALL_WRITE_PCIBRIDGE_REG, SIOC_WAN_GET_CARD_TYPE
}
 Wanpipe Commands associated with WANPIPE_IOCTL_DEVEL Ioctl. More...


Detailed Description

WANPIPE(tm) Driver API - Provides FULL Wanpipe Driver API Support Full API includes: Management/Configuration/IO/Events.

Authors: Nenad Corbic <ncorbic@sangoma.com> David Rokhvarg <davidr@sangoma.com> Alex Feldman <alex@sangoma.com>

Copyright (c) 2007 - 08, Sangoma Technologies All rights reserved.

* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the Sangoma Technologies nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY Sangoma Technologies ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL Sangoma Technologies BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS ===============================================================================

Definition in file wanpipe_api.h.


Define Documentation

#define WP_API_EVENT_MODE_DECODE ( mode   ) 

Value:

((mode) == WP_API_EVENT_ENABLE) ? "Enable" :        \
        ((mode) == WP_API_EVENT_DISABLE) ? "Disable" :      \
                        "(Unknown mode)"
Decode disable/enable command.

Definition at line 60 of file wanpipe_api.h.

#define GLOBAL_UDP_SIGNATURE   "WANPIPE"

WANPIPE LEGACY API

Definition at line 102 of file wanpipe_api.h.


Enumeration Type Documentation

enum wanpipe_aft_devel_events

Wanpipe Commands associated with WANPIPE_IOCTL_DEVEL Ioctl.

The Devel Commands are used to debug the driver and firmware. Should only be used during debugging.

Definition at line 304 of file wanpipe_api.h.

00304                               {
00305     SIOC_WAN_READ_REG = 0x01,
00306     SIOC_WAN_WRITE_REG,
00307     SIOC_WAN_HWPROBE,
00308     SIOC_WAN_ALL_HWPROBE,
00309     SIOC_WAN_ALL_READ_REG,
00310     SIOC_WAN_ALL_WRITE_REG,
00311     SIOC_WAN_ALL_SET_PCI_BIOS,
00312     SIOC_WAN_SET_PCI_BIOS,
00313     SIOC_WAN_COREREV,
00314     SIOC_WAN_GET_CFG,
00315     SIOC_WAN_FE_READ_REG,
00316     SIOC_WAN_FE_WRITE_REG,
00317     SIOC_WAN_EC_REG,
00318     SIOC_WAN_READ_PCIBRIDGE_REG,
00319     SIOC_WAN_ALL_READ_PCIBRIDGE_REG,
00320     SIOC_WAN_WRITE_PCIBRIDGE_REG,
00321     SIOC_WAN_ALL_WRITE_PCIBRIDGE_REG,
00322     SIOC_WAN_GET_CARD_TYPE
00323 };


Generated on Tue Jan 6 18:07:45 2009 for sample_c by  doxygen 1.4.7