| Sjur Braendeland | 2721c5b | 2010-03-30 13:56:22 +0000 | [diff] [blame^] | 1 | /* |
| 2 | * Copyright (C) ST-Ericsson AB 2010 |
| 3 | * Author: Sjur Brendeland/ sjur.brandeland@stericsson.com |
| 4 | * License terms: GNU General Public License (GPL) version 2 |
| 5 | */ |
| 6 | |
| 7 | #ifndef CAIF_DEV_H_ |
| 8 | #define CAIF_DEV_H_ |
| 9 | |
| 10 | #include <net/caif/caif_layer.h> |
| 11 | #include <net/caif/cfcnfg.h> |
| 12 | #include <linux/caif/caif_socket.h> |
| 13 | #include <linux/if.h> |
| 14 | |
| 15 | /** |
| 16 | * struct caif_param - CAIF parameters. |
| 17 | * @size: Length of data |
| 18 | * @data: Binary Data Blob |
| 19 | */ |
| 20 | struct caif_param { |
| 21 | u16 size; |
| 22 | u8 data[256]; |
| 23 | }; |
| 24 | |
| 25 | /** |
| 26 | * caif_connect_request - Request data for CAIF channel setup. |
| 27 | * @sockaddr: Socket address to connect. |
| 28 | * @priority: Priority of the connection. |
| 29 | * @link_selector: Link selector (high bandwidth or low latency) |
| 30 | * @link_name: Name of the CAIF Link Layer to use. |
| 31 | * |
| 32 | * This struct is used when connecting a CAIF channel. |
| 33 | * It contains all CAIF channel configuration options. |
| 34 | */ |
| 35 | struct caif_connect_request { |
| 36 | int protocol; |
| 37 | struct sockaddr_caif sockaddr; |
| 38 | enum caif_channel_priority priority; |
| 39 | enum caif_link_selector link_selector; |
| 40 | char link_name[16]; |
| 41 | struct caif_param param; |
| 42 | }; |
| 43 | |
| 44 | /** |
| 45 | * caif_connect_client - Connect a client to CAIF Core Stack. |
| 46 | * @config: Channel setup parameters, specifying what address |
| 47 | * to connect on the Modem. |
| 48 | * @client_layer: User implementation of client layer. This layer |
| 49 | * MUST have receive and control callback functions |
| 50 | * implemented. |
| 51 | * |
| 52 | * This function connects a CAIF channel. The Client must implement |
| 53 | * the struct cflayer. This layer represents the Client layer and holds |
| 54 | * receive functions and control callback functions. Control callback |
| 55 | * function will receive information about connect/disconnect responses, |
| 56 | * flow control etc (see enum caif_control). |
| 57 | * E.g. CAIF Socket will call this function for each socket it connects |
| 58 | * and have one client_layer instance for each socket. |
| 59 | */ |
| 60 | int caif_connect_client(struct caif_connect_request *config, |
| 61 | struct cflayer *client_layer); |
| 62 | |
| 63 | /** |
| 64 | * caif_disconnect_client - Disconnects a client from the CAIF stack. |
| 65 | * |
| 66 | * @client_layer: Client layer to be removed. |
| 67 | */ |
| 68 | int caif_disconnect_client(struct cflayer *client_layer); |
| 69 | |
| 70 | /** |
| 71 | * connect_req_to_link_param - Translate configuration parameters |
| 72 | * from socket format to internal format. |
| 73 | * @cnfg: Pointer to configuration handler |
| 74 | * @con_req: Configuration parameters supplied in function |
| 75 | * caif_connect_client |
| 76 | * @channel_setup_param: Parameters supplied to the CAIF Core stack for |
| 77 | * setting up channels. |
| 78 | * |
| 79 | */ |
| 80 | int connect_req_to_link_param(struct cfcnfg *cnfg, |
| 81 | struct caif_connect_request *con_req, |
| 82 | struct cfctrl_link_param *channel_setup_param); |
| 83 | |
| 84 | /** |
| 85 | * get_caif_conf() - Get the configuration handler. |
| 86 | */ |
| 87 | struct cfcnfg *get_caif_conf(void); |
| 88 | |
| 89 | |
| 90 | #endif /* CAIF_DEV_H_ */ |