fci/lib/include/libfci.h

/*
 *
 *  Copyright (C) 2007 Mindspeed Technologies, Inc.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation; either version 2.1 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef _FCILIB_H
#define _FCILIB_H

#include <linux/netlink.h>

/* FCI messages definitions */
#define FCI_MAX_PAYLOAD 256


/* Supported netlink protocol types */
#define FCILIB_FF_TYPE	0 /* NETLINK_FF */
#define FCILIB_KEY_TYPE	2 /* NETLINK_KEY */

/* Netlink multicast groups supported by FCI */
#define NL_FF_GROUP		(1 << 0)
#define NL_KEY_SA_GROUP		(1 << 0)
#define NL_KEY_FLOW_GROUP	(1 << 1)
#define NL_KEY_ALL_GROUP	(NL_KEY_SA_GROUP | NL_KEY_FLOW_GROUP)

/* FCI callbacks return codes */
enum FCI_CB_ACTION {
	FCI_CB_STOP = 0,		/* stop catching event from FCI */
	FCI_CB_CONTINUE,	/* continue event catching */
};

/*
* Structures
*
*/

typedef struct t_FCI_CLIENT
{
	int nl_sock_id;
	int nl_type;
	struct sockaddr_nl src_addr;
	struct sockaddr_nl dst_addr;
	int (*event_cb)(unsigned short fcode, unsigned short len, unsigned short *payload);
	
} FCI_CLIENT;


/*
* Prototypes
*/
FCI_CLIENT * fci_open(unsigned long socket_type, unsigned long group);
int fci_close(FCI_CLIENT *client);
int fci_catch(FCI_CLIENT *client);
int fci_cmd(FCI_CLIENT *this_client, unsigned short fcode, unsigned short *cmd_buf, unsigned short cmd_len, unsigned short *rep_buf, unsigned short *rep_len);
int fci_write(FCI_CLIENT *client, unsigned short fcode, unsigned short len, unsigned short *payload);
int fci_register_cb(FCI_CLIENT *client, int (*event_cb)(unsigned short fcode, unsigned short len, unsigned short *payload));
int fci_query(FCI_CLIENT *this_client, unsigned short fcode, unsigned short length, unsigned short *pcmd, unsigned short *rsplen, unsigned short *rsp_data);
int fci_fd(FCI_CLIENT *this_client);
#endif