Refactor to use new protocol module and sipo.
[bertos.git] / bertos / drv / ft245rl.h
1 /**
2  * \file
3  * <!--
4  * This file is part of BeRTOS.
5  *
6  * Bertos is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
19  *
20  * As a special exception, you may use this file as part of a free software
21  * library without restriction.  Specifically, if other files instantiate
22  * templates or use macros or inline functions from this file, or you compile
23  * this file and link it with other files to produce an executable, this
24  * file does not by itself cause the resulting executable to be covered by
25  * the GNU General Public License.  This exception does not however
26  * invalidate any other reasons why the executable file might be covered by
27  * the GNU General Public License.
28  *
29  * Copyright 2009 Develer S.r.l. (http://www.develer.com/)
30  *
31  * -->
32  *
33  * \brief Function library for Accessing FT245RL USB interface.
34  *
35  *
36  * \author Francesco Sacchi <batt@develer.com>
37  *
38  * $WIZ$ module_name = "ft245rl"
39  * $WIZ$ module_depends = "kfile", "timer"
40  * $WIZ$ module_hw = "bertos/hw/hw_ft245rl.h"
41  */
42
43
44 #ifndef DRV_FT245RL_H
45 #define DRV_FT245RL_H
46
47 #include <io/kfile.h>
48 #include <cfg/compiler.h>
49
50 /**
51  * ID for FT245RL KFiles.
52  */
53 #define KFT_FT245RL MAKE_ID('F', '2', '4', '5')
54
55 /**
56  * Ft245rl KFile context structure.
57  */
58 typedef struct Ft245rl
59 {
60         KFile fd; ///< File descriptor.
61 } Ft245rl;
62
63
64 /**
65  * Convert + ASSERT from generic KFile to KFileFt245rl.
66  */
67 INLINE Ft245rl * FT245RL_CAST(KFile *fd)
68 {
69         ASSERT(fd->_type == KFT_FT245RL);
70         return (Ft245rl *)fd;
71 }
72
73 void ft245rl_init(Ft245rl *fd);
74
75 #endif /* DRV_FT245RL_H */