bertos/drv/sipo.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 Generic Serial-in, Parallel-out implementation (SIPO).
  34  *
  35  *
  36  *
  37  * \author Andrea Grandi <andrea@develer.com>
  38  * \author Daniele Basile <asterix@develer.com>
  39  *
  40  * $WIZ$ module_name = "sipo"
  41  * $WIZ$ module_depends = "kfile"
  42  * $WIZ$ module_hw = "bertos/hw/hw_sipo.h"
  43  */
  44
  45
  46
  47
  48
  49 #ifndef DRV_SIPO_H
  50 #define DRV_SIPO_H
  51
  52 #include "hw/hw_sipo.h"
  53
  54 #include <io/kfile.h>
  55
  56 #define SIPO_DATAORDER_START_LSB        1
  57 #define SIPO_DATAORDER_START_MSB     0x80
  58
  59 /**
  60  * Define enum to set sipo data order.
  61  */
  62 typedef enum SipoBitOrder
  63 {
  64         SIPO_DATAORDER_MSB = 0,
  65         SIPO_DATAORDER_LSB = 1
  66 } SipoBitOrder;
  67
  68 /**
  69  * Define enum to set the start level of clock.
  70  */
  71 typedef enum SipoClockPol
  72 {
  73         SIPO_START_LOW = 0,
  74         SIPO_START_HIGH = 1
  75
  76 } SipoClkPol;
  77
  78 /**
  79  * Define enum to set load signal level.
  80  */
  81 typedef enum SipoLoadPol
  82 {
  83         SIPO_LOW_TO_HIGH = 0,
  84         SIPO_HIGH_TO_LOW = 1
  85
  86 } SipoLoadPol;
  87
  88 /**
  89  * Sipo KFile context structure.
  90  */
  91 typedef struct Sipo
  92 {
  93         KFile fd;                 ///< File descriptor.
  94         SipoMap load_device;      ///< Descriptor of the device that we want drive.
  95         SipoLoadPol load_pol;     ///< Set polarity of load signal.
  96         SipoClkPol clock_pol;     ///< Set polarity of data clock.
  97         SipoBitOrder bit_order;   ///< Set the order of pushed bits in sipo.
  98
  99 } Sipo;
 100
 101 /**
 102  * ID for sipo.
 103  */
 104 #define KFT_SIPO MAKE_ID('S', 'I', 'P', 'O')
 105
 106 /**
 107  * Convert + ASSERT from generic KFile to Sipo.
 108  */
 109 INLINE Sipo * SIPO_CAST(KFile *fd)
 110 {
 111         ASSERT(fd->_type == KFT_SIPO);
 112         return (Sipo *)fd;
 113 }
 114
 115 void sipo_init(Sipo *fd);
 116
 117 #endif // DRV_SIPO_H
 118