Sangoma Driver and Hardware Configuration, Operation. More...

#include "libsangoma-pvt.h"
#include "libsangoma.h"

Include dependency graph for libsangoma_config.c:

Functions
int	sangoma_port_mgmnt_ioctl (sng_fd_t fd, port_management_struct_t *port_management)

int	sangoma_port_cfg_ioctl (sng_fd_t fd, port_cfg_t *port_cfg)

sng_fd_t _LIBSNG_CALL	sangoma_open_driver_ctrl (int port_no)
	Open a Global Driver Control Device. More...

int _LIBSNG_CALL	sangoma_mgmt_cmd (sng_fd_t fd, wan_udp_hdr_t *wan_udp)
	Execute Sangoma Management Command. More...

int _LIBSNG_CALL	sangoma_driver_port_start (sng_fd_t fd, port_management_struct_t *port_mgmnt, unsigned short port_no)
	Start a Port, create Sangoma Communication interfaces. More...

int _LIBSNG_CALL	sangoma_driver_port_stop (sng_fd_t fd, port_management_struct_t *port_mgmnt, unsigned short port_no)
	Start a Port, create Sangoma Communication interfaces. More...

int _LIBSNG_CALL	sangoma_driver_get_hw_info (sng_fd_t fd, port_management_struct_t *port_mgmnt, unsigned short port_no)
	Retrieve information about a single instance of Sangoma hardware. More...

int _LIBSNG_CALL	sangoma_driver_get_version (sng_fd_t fd, port_management_struct_t *port_mgmnt, unsigned short port_no)
	Retrieve Driver Version BEFORE any communication interface is configured and sangoma_get_driver_version() can not be called. More...

int _LIBSNG_CALL	sangoma_driver_hw_rescan (sng_fd_t fd, port_management_struct_t port_mgmnt, int cnt)
	Rescan the pci and usb bus for newly added hardware. More...

int _LIBSNG_CALL	sangoma_driver_port_set_config (sng_fd_t fd, port_cfg_t *port_cfg, unsigned short port_no)
	Set Port's "Volatile" configuration. The configuration will not persist between system restarts. Before calling this function please stop the port by calling sangoma_driver_port_stop(). After calling this function please start the port by calling sangoma_driver_port_start(). More...

int _LIBSNG_CALL	sangoma_driver_port_get_config (sng_fd_t fd, port_cfg_t *port_cfg, unsigned short port_no)
	Retrieve Port's "Volatile" configuration. More...

int _LIBSNG_CALL	sangoma_write_port_config_on_persistent_storage (hardware_info_t hardware_info, port_cfg_t port_cfg, unsigned short port_no)

Detailed Description

Sangoma Driver and Hardware Configuration, Operation.

Author(s): Nenad Corbic, David Rokhvarg

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 libsangoma_config.c.

Function Documentation

int sangoma_port_mgmnt_ioctl	(	sng_fd_t	fd,
		port_management_struct_t *	port_management
	)

Device PORT Control Functions

Definition at line 42 of file libsangoma_config.c.

References FALSE, SANG_STATUS_INVALID_DEVICE, and WANPIPE_IOCTL_PORT_MGMT.

Referenced by sangoma_driver_get_hw_info(), sangoma_driver_get_version(), sangoma_driver_hw_rescan(), sangoma_driver_port_start(), and sangoma_driver_port_stop().

 {
     int err = 0;
 #if defined(__WINDOWS__)
     DWORD ln;
     if(DeviceIoControl(
             fd,
             IoctlPortManagementCommand,
             (LPVOID)port_management,
             sizeof(port_management_struct_t),
             (LPVOID)port_management,
             sizeof(port_management_struct_t),
             (LPDWORD)(&ln),
             (LPOVERLAPPED)NULL
                         ) == FALSE){
         /* Call OS specific code to find cause of the error and check messages log. */
         DBG_ERR("%s():Error: IoctlPortManagementCommand failed!!\n", __FUNCTION__);
         err = -1;
     }
 #else
     err=ioctl(fd,WANPIPE_IOCTL_PORT_MGMT,port_management);
     if (err) {
         err = -1;
     }
 #endif
     if(err){
         port_management->operation_status = SANG_STATUS_INVALID_DEVICE;
     }
 
     return err;
 }

Here is the caller graph for this function:

sng_fd_t sangoma_open_driver_ctrl ( int port_no )

Open a Global Driver Control Device.

Returns: File Descriptor - negative=error 0 or greater = fd

The global control device receives events for all devices configured.

Definition at line 107 of file libsangoma_config.c.

References _snprintf, FNAME_LEN, sangoma_open_dev_by_name(), and WP_PORT_NAME_FORM.

 {
     char tmp_fname[FNAME_LEN];
 
 #if defined(__WINDOWS__)
     /* Form the Config Device Name (i.e. wanpipe1, wanpipe2,...). */
     _snprintf(tmp_fname, DEV_NAME_LEN, WP_PORT_NAME_FORM, port_no);
 #else
     /* Form the Config Device Name. ("/dev/wanpipe") */
     _snprintf(tmp_fname, DEV_NAME_LEN, WP_CONFIG_DEV_NAME);
 #endif
     return sangoma_open_dev_by_name(tmp_fname);
 }

Here is the call graph for this function:

int sangoma_mgmt_cmd	(	sng_fd_t	fd,
		wan_udp_hdr_t *	wan_udp
	)

Execute Sangoma Management Command.

Device MANAGEMENT Functions

Parameters

fd	device file descriptor
wan_udp	management command structure

Returns: non-zero: error, 0: ok

Definition at line 122 of file libsangoma_config.c.

References WANPIPE_IOCTL_PIPEMON.

Referenced by sangoma_fe_reg_read(), sangoma_fe_reg_write(), sangoma_get_aft_customer_id(), and sangoma_port_led_ctrl().

 {
     int err=0;
 #if defined(__WINDOWS__)
     if(UdpManagementCommand(fd, wan_udp)){
         err = 1;
     }
 #else
     unsigned char id = 0;
 
     wan_udp->wan_udphdr_request_reply = 0x01;
     wan_udp->wan_udphdr_id = id;
     wan_udp->wan_udphdr_return_code = WAN_UDP_TIMEOUT_CMD;
 
     err=ioctl(fd,WANPIPE_IOCTL_PIPEMON,wan_udp);
     if (err < 0) {
         err = 1;
     }
 #endif
     if(err){
         /* The ioctl failed. */
         return err;
     }
 
     /* The ioctl was successfull. The caller must check
      * value of wan_udp->wan_udphdr_return_code. */
     return 0;
 }

Here is the caller graph for this function:

int sangoma_driver_port_start	(	sng_fd_t	fd,
		port_management_struct_t *	port_mgmnt,
		unsigned short	port_no
	)

Start a Port, create Sangoma Communication interfaces.

Device PORT Control Functions

Parameters

[in]	fd	Port Device file descriptor
[out]	port_mgmnt	pointer to a port_management_struct_t structure. On return, sangoma_driver_port_start() updates operation_status field of this structure.
[in]	port_no	1-based Port Number. Port numbers correspond to Port Names. For example, a 2-Port card will have ports named WANPIPE1 and WANPIPE2.

Returns: non-zero: system error. Call OS specific code to find cause of the error. Linux example: strerror(errno) Windows example: combination of GetLastError()/FormatMessage() zero: no system error. Check port_mgmt->operation_status.

Definition at line 151 of file libsangoma_config.c.

References SANG_STATUS_GENERAL_ERROR, and sangoma_port_mgmnt_ioctl().

 {
     int err;
     port_mgmnt->operation_status = SANG_STATUS_GENERAL_ERROR;
     port_mgmnt->command_code = START_PORT_VOLATILE_CONFIG;
     port_mgmnt->port_no = port_no;
 
     err = sangoma_port_mgmnt_ioctl(fd, port_mgmnt);
     if (err) {
         /* ioctl failed */
         return err;
     }
 
     return port_mgmnt->operation_status;
 }

Here is the call graph for this function:

int sangoma_driver_port_stop	(	sng_fd_t	fd,
		port_management_struct_t *	port_mgmnt,
		unsigned short	port_no
	)

Start a Port, create Sangoma Communication interfaces.

Parameters

[in]	fd	Port Device file descriptor
[out]	port_mgmnt	pointer to a port_management_struct_t structure. On return, sangoma_driver_port_stop() updates operation_status field of this structure.
[in]	port_no	1-based Port Number. Port numbers correspond to Port Names. For example, a 2-Port card will have ports named WANPIPE1 and WANPIPE2.

Returns: non-zero: system error. Call OS specific code to find cause of the error. Linux example: strerror(errno) Windows example: combination of GetLastError()/FormatMessage() zero: no system error. Check port_mgmt->operation_status.

Definition at line 167 of file libsangoma_config.c.

References SANG_STATUS_CAN_NOT_STOP_DEVICE_WHEN_ALREADY_STOPPED, SANG_STATUS_GENERAL_ERROR, SANG_STATUS_SUCCESS, and sangoma_port_mgmnt_ioctl().

 {
     int err;
     port_mgmnt->operation_status = SANG_STATUS_GENERAL_ERROR;
     port_mgmnt->command_code = STOP_PORT;
     port_mgmnt->port_no = port_no;
 
     err = sangoma_port_mgmnt_ioctl(fd, port_mgmnt);
     if (err) {
         /* ioctl failed */
         return err;
     }
 
     switch(port_mgmnt->operation_status)
     {
     case SANG_STATUS_CAN_NOT_STOP_DEVICE_WHEN_ALREADY_STOPPED:
         /* This is not an error, rather a state indication.
          * Return SANG_STATUS_SUCCESS, but real return code will be available
          * for the caller at port_mgmnt->operation_status. */
         err = SANG_STATUS_SUCCESS;
         break;
     default:
         err = port_mgmnt->operation_status;
         break;
     }
 
     return err;
 }

Here is the call graph for this function:

int sangoma_driver_get_hw_info	(	sng_fd_t	fd,
		port_management_struct_t *	port_mgmnt,
		unsigned short	port_no
	)

Retrieve information about a single instance of Sangoma hardware.

Parameters

[in]	fd	Port Device file descriptor
[out]	port_mgmnt	pointer to port_management_struct_t structure which will contain hardware_info_t at it's "data" field, when this function returns.
[in]	port_no	please see comment of sangoma_driver_port_set_config()

Returns: non-zero: system error. Call OS specific code to find cause of the error. Linux example: strerror(errno) Windows example: combination of GetLastError()/FormatMessage() zero: no system error. Check port_mgmt->operation_status.

Definition at line 196 of file libsangoma_config.c.

References SANG_STATUS_GENERAL_ERROR, and sangoma_port_mgmnt_ioctl().

 {
     int err;
     port_mgmnt->operation_status = SANG_STATUS_GENERAL_ERROR;
     port_mgmnt->command_code = GET_HARDWARE_INFO;
     port_mgmnt->port_no     = port_no;
 
     err = sangoma_port_mgmnt_ioctl(fd, port_mgmnt);
     if (err) {
         return err;
     }
 
     return port_mgmnt->operation_status;
 }

Here is the call graph for this function:

int sangoma_driver_get_version	(	sng_fd_t	fd,
		port_management_struct_t *	port_mgmnt,
		unsigned short	port_no
	)

Retrieve Driver Version BEFORE any communication interface is configured and sangoma_get_driver_version() can not be called.

Parameters

[in]	fd	Port Device file descriptor
[out]	port_mgmnt	pointer to port_management_struct_t structure which will contain wan_driver_version_t at it's "data" field, when this function returns.
[in]	port_no	please see comment of sangoma_driver_port_set_config()

Returns: non-zero: system error. Call OS specific code to find cause of the error. Linux example: strerror(errno) Windows example: combination of GetLastError()/FormatMessage() zero: no system error. Check port_mgmt->operation_status.

Definition at line 211 of file libsangoma_config.c.

References sangoma_port_mgmnt_ioctl().

 {
         int err;
         port_mgmnt->command_code = GET_DRIVER_VERSION;
         port_mgmnt->port_no     = port_no;
 
         err = sangoma_port_mgmnt_ioctl(fd, port_mgmnt);
         if (err) {
                 return err;
         }
 
         return port_mgmnt->operation_status;
 }

Here is the call graph for this function:

int sangoma_driver_hw_rescan	(	sng_fd_t	fd,
		port_management_struct_t *	port_mgmnt,
		int *	detected_port_cnt
	)

Rescan the pci and usb bus for newly added hardware.

Parameters

[in]	fd	Port Device file descriptor
[out]	port_mgmnt	pointer to port_management_struct_t structure which will contain wan_driver_version_t at it's "data" field, when this function returns.
[out]	detected_port_cnt	newly detected ports.

Returns: less than zero: system error. Call OS specific code to find cause of the error. Linux example: strerror(errno) Windows example: combination of GetLastError()/FormatMessage() zero or greater: number of new ports found.

Definition at line 226 of file libsangoma_config.c.

References sangoma_port_mgmnt_ioctl().

 {
     int err;
     port_mgmnt->command_code = WANPIPE_HARDWARE_RESCAN;
     port_mgmnt->port_no     = 1;
 
     err = sangoma_port_mgmnt_ioctl(fd, port_mgmnt);
     if (err < 0) {
         return err;
     }
 
     *cnt=port_mgmnt->port_no;
      
     return port_mgmnt->operation_status;   
 }

Here is the call graph for this function:

int sangoma_driver_port_set_config	(	sng_fd_t	fd,
		port_cfg_t *	port_cfg,
		unsigned short	port_no
	)

Set Port's "Volatile" configuration. The configuration will not persist between system restarts. Before calling this function please stop the port by calling sangoma_driver_port_stop(). After calling this function please start the port by calling sangoma_driver_port_start().

Parameters

[in]	fd	Port Device file descriptor
[in,out]	port_cfg	pointer to port_cfg_t structure that specifies complete Port configuration. On return, sangoma_driver_port_set_config() updates operation_status field of this structure.
[in]	port_no	1-based Port Number. Port numbers correspond to Port Names. For example, a 2-Port card will have ports named WANPIPE1 and WANPIPE2.

Returns: non-zero: system error. Call OS specific code to find cause of the error. Linux example: strerror(errno) Windows example: combination of GetLastError()/FormatMessage() zero: no system error. Check port_cfg->operation_status.

Definition at line 244 of file libsangoma_config.c.

References SANG_STATUS_GENERAL_ERROR.

 {
     port_cfg->operation_status = SANG_STATUS_GENERAL_ERROR;
     port_cfg->command_code = SET_PORT_VOLATILE_CONFIG;
     port_cfg->port_no   = port_no;
 
     return sangoma_port_cfg_ioctl(fd, port_cfg);
 }

int sangoma_driver_port_get_config	(	sng_fd_t	fd,
		port_cfg_t *	port_cfg,
		unsigned short	port_no
	)

Retrieve Port's "Volatile" configuration.

Parameters

[in]	fd	Port Device file descriptor
[out]	port_cfg	pointer to port_cfg_t structure. On return, sangoma_driver_port_get_config() will copy current Port configuration into this structure.
[in]	port_no	please see comment of sangoma_driver_port_set_config()

Returns: non-zero: system error. Call OS specific code to find cause of the error. Linux example: strerror(errno) Windows example: combination of GetLastError()/FormatMessage() zero: no system error. Check port_cfg->operation_status.

Definition at line 253 of file libsangoma_config.c.

References SANG_STATUS_GENERAL_ERROR.

 {
     port_cfg->operation_status = SANG_STATUS_GENERAL_ERROR;
     port_cfg->command_code = GET_PORT_VOLATILE_CONFIG;
     port_cfg->port_no = port_no;
     return sangoma_port_cfg_ioctl(fd, port_cfg);
 }