Blame view

mbed/BusInOut.h 3.21 KB
f7c9a8e1   jdenecha   Feat : Firt dump
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
  /* mbed Microcontroller Library

   * Copyright (c) 2006-2013 ARM Limited

   *

   * Licensed under the Apache License, Version 2.0 (the "License");

   * you may not use this file except in compliance with the License.

   * You may obtain a copy of the License at

   *

   *     http://www.apache.org/licenses/LICENSE-2.0

   *

   * Unless required by applicable law or agreed to in writing, software

   * distributed under the License is distributed on an "AS IS" BASIS,

   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

   * See the License for the specific language governing permissions and

   * limitations under the License.

   */

  #ifndef MBED_BUSINOUT_H

  #define MBED_BUSINOUT_H

  

  #include "DigitalInOut.h"

  

  namespace mbed {

  

  /** A digital input output bus, used for setting the state of a collection of pins

   */

  class BusInOut {

  

  public:

  

      /** Create an BusInOut, connected to the specified pins

       *

       *  @param p<n> DigitalInOut pin to connect to bus bit p<n> (p5-p30, NC)

       *

       *  @note

       *  It is only required to specify as many pin variables as is required

       *  for the bus; the rest will default to NC (not connected)

       */

      BusInOut(PinName p0, PinName p1 = NC, PinName p2 = NC, PinName p3 = NC,

               PinName p4 = NC, PinName p5 = NC, PinName p6 = NC, PinName p7 = NC,

               PinName p8 = NC, PinName p9 = NC, PinName p10 = NC, PinName p11 = NC,

               PinName p12 = NC, PinName p13 = NC, PinName p14 = NC, PinName p15 = NC);

  

      BusInOut(PinName pins[16]);

  

      virtual ~BusInOut();

  

      /* Group: Access Methods */

  

      /** Write the value to the output bus

       *

       *  @param value An integer specifying a bit to write for every corresponding DigitalInOut pin

       */

      void write(int value);

  

      /** Read the value currently output on the bus

       *

       *  @returns

       *    An integer with each bit corresponding to associated DigitalInOut pin setting

       */

      int read();

  

      /** Set as an output

       */

      void output();

  

      /** Set as an input

       */

      void input();

  

      /** Set the input pin mode

       *

       *  @param mode PullUp, PullDown, PullNone

       */

      void mode(PinMode pull);

  

      /** Binary mask of bus pins connected to actual pins (not NC pins)

       *  If bus pin is in NC state make corresponding bit will be cleared (set to 0), else bit will be set to 1

       *

       *  @returns

       *    Binary mask of connected pins

       */

      int mask() {

          return _nc_mask;

      }

  

  #ifdef MBED_OPERATORS

       /** A shorthand for write()

       */

      BusInOut& operator= (int v);

      BusInOut& operator= (BusInOut& rhs);

  

      /** Access to particular bit in random-iterator fashion

      */

      DigitalInOut& operator[] (int index);

  

      /** A shorthand for read()

       */

      operator int();

  #endif

  

  protected:

      DigitalInOut* _pin[16];

  

      /** Mask of bus's NC pins

       * If bit[n] is set to 1 - pin is connected

       * if bit[n] is cleared - pin is not connected (NC)

       */

      int _nc_mask;

  

      /* disallow copy constructor and assignment operators */

  private:

      BusInOut(const BusInOut&);

      BusInOut & operator = (const BusInOut&);

  };

  

  } // namespace mbed

  

  #endif