Donatien Garnier
ZG2100 Network interface source
drv/zg2100/zg_com.h@4:e00281c7453d, 2010-08-06 (annotated)
- Committer:
- donatien
- Date:
- Fri Aug 06 10:46:03 2010 +0000
- Revision:
- 4:e00281c7453d
- Parent:
- 3:c4f7efa7d8c3
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| donatien | 0:b802fc31f1db | 1 | |
| donatien | 0:b802fc31f1db | 2 | /* |
| donatien | 0:b802fc31f1db | 3 | Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com) |
| donatien | 0:b802fc31f1db | 4 | |
| donatien | 0:b802fc31f1db | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy |
| donatien | 0:b802fc31f1db | 6 | of this software and associated documentation files (the "Software"), to deal |
| donatien | 0:b802fc31f1db | 7 | in the Software without restriction, including without limitation the rights |
| donatien | 0:b802fc31f1db | 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| donatien | 0:b802fc31f1db | 9 | copies of the Software, and to permit persons to whom the Software is |
| donatien | 0:b802fc31f1db | 10 | furnished to do so, subject to the following conditions: |
| donatien | 0:b802fc31f1db | 11 | |
| donatien | 0:b802fc31f1db | 12 | The above copyright notice and this permission notice shall be included in |
| donatien | 0:b802fc31f1db | 13 | all copies or substantial portions of the Software. |
| donatien | 0:b802fc31f1db | 14 | |
| donatien | 0:b802fc31f1db | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| donatien | 0:b802fc31f1db | 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| donatien | 0:b802fc31f1db | 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| donatien | 0:b802fc31f1db | 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| donatien | 0:b802fc31f1db | 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| donatien | 0:b802fc31f1db | 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
| donatien | 0:b802fc31f1db | 21 | THE SOFTWARE. |
| donatien | 0:b802fc31f1db | 22 | */ |
| donatien | 0:b802fc31f1db | 23 | |
| donatien | 2:ac860ad9e490 | 24 | /** |
| donatien | 3:c4f7efa7d8c3 | 25 | @file |
| donatien | 3:c4f7efa7d8c3 | 26 | ZG2100 Low-level communication functions (SPI, CS, Interrupt) |
| donatien | 2:ac860ad9e490 | 27 | */ |
| donatien | 0:b802fc31f1db | 28 | //Donatien Garnier 2010 |
| donatien | 0:b802fc31f1db | 29 | |
| donatien | 0:b802fc31f1db | 30 | #ifndef ZG_COM_H |
| donatien | 0:b802fc31f1db | 31 | #define ZG_COM_H |
| donatien | 0:b802fc31f1db | 32 | |
| donatien | 0:b802fc31f1db | 33 | #include "mbed.h" |
| donatien | 0:b802fc31f1db | 34 | #include "zg_defs.h" |
| donatien | 0:b802fc31f1db | 35 | |
| donatien | 0:b802fc31f1db | 36 | //Defines |
| donatien | 0:b802fc31f1db | 37 | |
| donatien | 0:b802fc31f1db | 38 | #define ZG_SPI_CS_ON 0 //Active on low |
| donatien | 0:b802fc31f1db | 39 | #define ZG_SPI_CS_OFF 1 |
| donatien | 0:b802fc31f1db | 40 | |
| donatien | 0:b802fc31f1db | 41 | #define ZG_SPI_RST_ON 0 //Active on low |
| donatien | 0:b802fc31f1db | 42 | #define ZG_SPI_RST_OFF 1 |
| donatien | 0:b802fc31f1db | 43 | |
| donatien | 0:b802fc31f1db | 44 | //Prototypes |
| donatien | 0:b802fc31f1db | 45 | /* |
| donatien | 0:b802fc31f1db | 46 | class SPI; |
| donatien | 0:b802fc31f1db | 47 | class DigitalOut; |
| donatien | 0:b802fc31f1db | 48 | class InterruptIn; |
| donatien | 0:b802fc31f1db | 49 | */ |
| donatien | 1:3a7c15057192 | 50 | ///Opens SPI interface with pins |
| donatien | 1:3a7c15057192 | 51 | void zg_com_init(SPI* pSpi, DigitalOut* pCs, /*InterruptIn*/ DigitalIn* pInt, DigitalOut* pNrst); |
| donatien | 0:b802fc31f1db | 52 | |
| donatien | 0:b802fc31f1db | 53 | //Registers Access |
| donatien | 1:3a7c15057192 | 54 | ///Reads register |
| donatien | 0:b802fc31f1db | 55 | uint32_t zg_register_read(uint32_t addr); |
| donatien | 0:b802fc31f1db | 56 | |
| donatien | 1:3a7c15057192 | 57 | ///Writes register |
| donatien | 0:b802fc31f1db | 58 | void zg_register_write(uint32_t addr, uint32_t reg); |
| donatien | 0:b802fc31f1db | 59 | |
| donatien | 0:b802fc31f1db | 60 | //Indexed Registers Access |
| donatien | 1:3a7c15057192 | 61 | ///Reads indexed register |
| donatien | 0:b802fc31f1db | 62 | uint32_t zg_indexed_register_read(uint32_t addr); |
| donatien | 0:b802fc31f1db | 63 | |
| donatien | 1:3a7c15057192 | 64 | ///writes indexed register |
| donatien | 0:b802fc31f1db | 65 | void zg_indexed_register_write(uint32_t addr, uint32_t reg); |
| donatien | 0:b802fc31f1db | 66 | |
| donatien | 0:b802fc31f1db | 67 | //Fifos |
| donatien | 1:3a7c15057192 | 68 | ///Reads FIFO |
| donatien | 0:b802fc31f1db | 69 | void zg_fifo_read( byte fifo, byte* pType, byte* pSubtype, byte* buf, int len ); |
| donatien | 0:b802fc31f1db | 70 | |
| donatien | 1:3a7c15057192 | 71 | ///Writes FIFO (can be chunked) |
| donatien | 0:b802fc31f1db | 72 | void zg_fifo_write( byte fifo, byte type, byte subtype, byte* buf, int len, bool start = true, bool stop = true ); //Write by chunks |
| donatien | 0:b802fc31f1db | 73 | |
| donatien | 0:b802fc31f1db | 74 | //Spi |
| donatien | 0:b802fc31f1db | 75 | |
| donatien | 1:3a7c15057192 | 76 | ///SPI transfers directions |
| donatien | 1:3a7c15057192 | 77 | typedef enum __ZG_SPI_DIR |
| donatien | 1:3a7c15057192 | 78 | { |
| donatien | 1:3a7c15057192 | 79 | ZG_SPI_READ, ///Read |
| donatien | 1:3a7c15057192 | 80 | ZG_SPI_WRITE, ///Write |
| donatien | 1:3a7c15057192 | 81 | ZG_SPI_TRF ///Read & Write |
| donatien | 1:3a7c15057192 | 82 | } ZG_SPI_DIR; |
| donatien | 0:b802fc31f1db | 83 | |
| donatien | 1:3a7c15057192 | 84 | ///Transfers SPI frame |
| donatien | 1:3a7c15057192 | 85 | void zg_spi_trf(byte* buf, int len, bool resetCs = true, ZG_SPI_DIR dir = ZG_SPI_TRF); |
| donatien | 1:3a7c15057192 | 86 | |
| donatien | 1:3a7c15057192 | 87 | ///Is there an interrupt to serve? |
| donatien | 1:3a7c15057192 | 88 | bool zg_is_int(); |
| donatien | 0:b802fc31f1db | 89 | |
| donatien | 0:b802fc31f1db | 90 | //Callbacks, must be implemented in zg_drv.c |
| donatien | 0:b802fc31f1db | 91 | |
| donatien | 0:b802fc31f1db | 92 | void zg_on_int(); //On data available interrupt |
| donatien | 0:b802fc31f1db | 93 | |
| donatien | 0:b802fc31f1db | 94 | |
| donatien | 0:b802fc31f1db | 95 | #endif |