Move per-transition delays from generic bit-bashing layer to i2c layer
[people/andreif/gpxe.git] / src / drivers / bitbash / bitbash.c
1 /*
2  * Copyright (C) 2006 Michael Brown <mbrown@fensystems.co.uk>.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License as
6  * published by the Free Software Foundation; either version 2 of the
7  * License, or any later version.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17  */
18
19 #include <timer.h>
20 #include <gpxe/bitbash.h>
21
22 /** @file
23  *
24  * Bit-bashing interfaces
25  *
26  */
27
28 /**
29  * Set/clear output bit
30  *
31  * @v basher            Bit-bashing interface
32  * @v bit_id            Bit number
33  * @v data              Value to write
34  * 
35  * If @c data is 0, a logic 0 will be written.  If @c data is
36  * non-zero, a logic 1 will be written.
37  */
38 void write_bit ( struct bit_basher *basher, unsigned int bit_id,
39                  unsigned long data ) {
40         basher->write ( basher, bit_id, ( data ? -1UL : 0 ) );
41 }
42
43 /**
44  * Read input bit
45  *
46  * @v basher            Bit-bashing interface
47  * @v bit_id            Bit number
48  * @ret data            Value read
49  *
50  * @c data will always be either 0 or -1UL.  The idea is that the
51  * caller can simply binary-AND the returned value with whatever mask
52  * it needs to apply.
53  */
54 int read_bit ( struct bit_basher *basher, unsigned int bit_id ) {
55         return ( basher->read ( basher, bit_id ) ? -1UL : 0 );
56 }