xpp: echo_loader.c: add AB id to messages
[dahdi/tools.git] / xpp / astribank_usb.h
1 #ifndef ASTRIBANK_USB_H
2 #define ASTRIBANK_USB_H
3 /*
4  * Written by Oron Peled <oron@actcom.co.il>
5  * Copyright (C) 2008, Xorcom
6  *
7  * All rights reserved.
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22  *
23  */
24
25 #include <stdio.h>
26 #include <xusb.h>
27 #include <xtalk.h>
28 #include "mpp.h"
29
30 /*
31  * Astribank handling
32  */
33
34 #define PACKET_SIZE     512
35
36 /* USB Endpoints */
37 #define MP_EP_OUT       0x04    /* Managment processor */
38 #define MP_EP_IN        0x88    /* Managment processor */
39
40 #define XPP_EP_OUT      0x02    /* XPP */
41 #define XPP_EP_IN       0x86    /* XPP */
42
43 /* USB firmware types */
44 #define USB_11xx        0
45 #define USB_FIRMWARE_II 1
46 #define USB_PIC         2
47
48 struct interface_type {
49         int     type_code;
50         int     num_interfaces;
51         int     my_interface_num;
52         int     num_endpoints;
53         int     my_ep_out;
54         int     my_ep_in;
55         char    *name;
56         int     endpoints[4];   /* for matching */
57 };
58
59 enum eeprom_burn_state {
60         BURN_STATE_NONE         = 0,
61         BURN_STATE_STARTED      = 1,
62         BURN_STATE_ENDED        = 2,
63         BURN_STATE_FAILED       = 3,
64 };
65
66 struct astribank_device {
67         struct xusb             *xusb;
68         struct xtalk_device     *xtalk_dev;
69         usb_dev_handle          *handle;
70         int                     my_interface_num;
71         int                     my_ep_out;
72         int                     my_ep_in;
73         char                    iInterface[BUFSIZ];
74         int                     is_usb2;
75         enum eeprom_type        eeprom_type;
76         enum eeprom_burn_state  burn_state;
77         uint8_t                 status;
78         uint8_t                 mpp_proto_version;
79         struct eeprom_table     *eeprom;
80         struct firmware_versions        fw_versions;
81         uint16_t                tx_sequenceno;
82 };
83
84 /*
85  * Prototypes
86  */
87 struct astribank_device *astribank_open(const char devpath[], int iface_num);
88 void astribank_close(struct astribank_device *astribank, int disconnected);
89 void show_astribank_info(const struct astribank_device *astribank);
90 int send_usb(struct astribank_device *astribank, char *buf, int len, int timeout);
91 int recv_usb(struct astribank_device *astribank, char *buf, size_t len, int timeout);
92 int flush_read(struct astribank_device *astribank);
93 int eeprom_fill(struct eeprom_table *eprm,
94                 const char *vendor,
95                 const char *product,
96                 const char *release,
97                 const char *label);
98 int astribank_has_twinstar(struct astribank_device *astribank);
99 int label_isvalid(const char *label);
100
101 #define AB_REPORT(report_type, astribank, fmt, ...) \
102         report_type("%s [%s]: " fmt, \
103                 xusb_devpath((astribank)->xusb), \
104                 xusb_serial((astribank)->xusb), \
105                 ## __VA_ARGS__)
106
107 #define AB_INFO(astribank, fmt, ...) \
108                 AB_REPORT(INFO, astribank, fmt, ## __VA_ARGS__)
109
110 #define AB_ERR(astribank, fmt, ...) \
111                 AB_REPORT(ERR, astribank, fmt, ## __VA_ARGS__)
112
113 #endif  /* ASTRIBANK_USB_H */