4 * This file is part of BeRTOS.
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.
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.
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
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.
29 * Copyright 2009 Develer S.r.l. (http://www.develer.com/)
33 * \brief Generic Serial-in, Parallel-out implementation (SIPO).
37 * \author Andrea Grandi <andrea@develer.com>
38 * \author Daniele Basile <asterix@develer.com>
40 * $WIZ$ module_name = "sipo"
41 * $WIZ$ module_depends = "kfile"
42 * $WIZ$ module_hw = "bertos/hw/hw_sipo.h"
48 #include "hw/hw_sipo.h"
49 #include "cfg/cfg_sipo.h"
55 * The following macros are needed to maintain compatibility with older sipo API.
56 * They can be safely removed once the old API is removed.
60 * \addtogroup sipo_api
64 #define sipo_init(...) PP_CAT(sipo_init ## _, COUNT_PARMS(__VA_ARGS__)) (__VA_ARGS__)
67 * Initialize SIPO module.
69 * To initialize the module you can write this code:
72 * sipo_init(&ctx, settings);
75 #define sipo_init(args...) PP_CAT(sipo_init ## _, COUNT_PARMS(args)) (args)
81 #define SIPO_DATAORDER_START_LSB 1
82 #define SIPO_DATAORDER_START_MSB 0x80
84 #if !CONFIG_SIPO_DISABLE_OLD_API
86 * Define enum to set sipo data order.
88 typedef enum SipoBitOrder
90 SIPO_DATAORDER_MSB = 0,
91 SIPO_DATAORDER_LSB = 1
95 * Define enum to set the start level of clock.
97 typedef enum SipoClockPol
105 * Define enum to set load signal level.
107 typedef enum SipoLoadPol
109 SIPO_LOW_TO_HIGH = 0,
115 * Sipo KFile context structure.
119 KFile fd; ///< File descriptor.
120 SipoMap load_device; ///< Descriptor of the device that we want drive.
121 SipoLoadPol load_pol; ///< Set polarity of load signal.
122 SipoClkPol clock_pol; ///< Set polarity of data clock.
123 SipoBitOrder bit_order; ///< Set the order of pushed bits in sipo.
128 #define SIPO_DATAORDER BV(0)
129 #define SIPO_DATAORDER_MSB BV(0) ///< MSB sipo data order setting
130 #define SIPO_DATAORDER_LSB 0 ///< LSB sipo data order setting
132 #define SIPO_CLOCK_POL BV(1)
133 #define SIPO_START_LOW BV(1) ///< sipo clock start level high setting
134 #define SIPO_START_HIGH 0 ///< sipo clock start level low setting
136 #define SIPO_LOAD_LEV BV(2)
137 #define SIPO_LOW_TO_HIGH BV(2) ///< sipo load high signal level setting.
138 #define SIPO_HIGH_TO_LOW 0 ///< sipo load low signal level setting.
141 * Sipo KFile context structure.
145 KFile fd; ///< File descriptor.
146 SipoMap device; ///< Descriptor of the device that we want drive.
155 #define KFT_SIPO MAKE_ID('S', 'I', 'P', 'O')
158 * Convert + ASSERT from generic KFile to Sipo.
160 INLINE Sipo * SIPO_CAST(KFile *fd)
162 ASSERT(fd->_type == KFT_SIPO);
166 void sipo_init_1(Sipo *fd);
167 void sipo_init_3(Sipo *fd, SipoMap dev, uint8_t settings);
169 #endif /* DRV_SIPO_H */