Michele Bavaro
max2769ssp0.h@0:be1765e9885e, 2011-01-25 (annotated)
- Committer:
- michelebavaro
- Date:
- Tue Jan 25 11:26:16 2011 +0000
- Revision:
- 0:be1765e9885e
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| michelebavaro | 0:be1765e9885e | 1 | #ifndef MAX2769SSP0_H |
| michelebavaro | 0:be1765e9885e | 2 | #define MAX2769SSP0_H |
| michelebavaro | 0:be1765e9885e | 3 | |
| michelebavaro | 0:be1765e9885e | 4 | #include "mbed.h" |
| michelebavaro | 0:be1765e9885e | 5 | |
| michelebavaro | 0:be1765e9885e | 6 | extern Serial pc; |
| michelebavaro | 0:be1765e9885e | 7 | extern DigitalOut myled1; |
| michelebavaro | 0:be1765e9885e | 8 | extern DigitalOut myled2; |
| michelebavaro | 0:be1765e9885e | 9 | |
| michelebavaro | 0:be1765e9885e | 10 | /** An MAX2769SSP0 class |
| michelebavaro | 0:be1765e9885e | 11 | * It configures a SSP0 slave with TI protocol |
| michelebavaro | 0:be1765e9885e | 12 | * @author Michele Bavaro |
| michelebavaro | 0:be1765e9885e | 13 | * More details about the function goes here |
| michelebavaro | 0:be1765e9885e | 14 | * |
| michelebavaro | 0:be1765e9885e | 15 | * An example: |
| michelebavaro | 0:be1765e9885e | 16 | * @code |
| michelebavaro | 0:be1765e9885e | 17 | * #include "max2769ssp0.h" |
| michelebavaro | 0:be1765e9885e | 18 | * #include "mbed.h" |
| michelebavaro | 0:be1765e9885e | 19 | * |
| michelebavaro | 0:be1765e9885e | 20 | * MAX2769SSP0 adcSSP0(p11, p12, p13, p14); |
| michelebavaro | 0:be1765e9885e | 21 | * const uint16_t *puiMem; |
| michelebavaro | 0:be1765e9885e | 22 | * |
| michelebavaro | 0:be1765e9885e | 23 | * void main() |
| michelebavaro | 0:be1765e9885e | 24 | * { |
| michelebavaro | 0:be1765e9885e | 25 | * |
| michelebavaro | 0:be1765e9885e | 26 | * } |
| michelebavaro | 0:be1765e9885e | 27 | * @endcode |
| michelebavaro | 0:be1765e9885e | 28 | */ |
| michelebavaro | 0:be1765e9885e | 29 | class MAX2769SSP0 |
| michelebavaro | 0:be1765e9885e | 30 | { |
| michelebavaro | 0:be1765e9885e | 31 | private: |
| michelebavaro | 0:be1765e9885e | 32 | int sppx; |
| michelebavaro | 0:be1765e9885e | 33 | |
| michelebavaro | 0:be1765e9885e | 34 | public: |
| michelebavaro | 0:be1765e9885e | 35 | /** Creates an MAX2769SSP0 object to program the chip |
| michelebavaro | 0:be1765e9885e | 36 | * |
| michelebavaro | 0:be1765e9885e | 37 | * @param _mosi Data Digital Input of 3-Wire Serial Interface. |
| michelebavaro | 0:be1765e9885e | 38 | * @param _sck Clock Digital Input of 3-Wire Serial Interface. |
| michelebavaro | 0:be1765e9885e | 39 | * Active when CS is low. Data is clocked in on the rising |
| michelebavaro | 0:be1765e9885e | 40 | * edge of the SCLK. |
| michelebavaro | 0:be1765e9885e | 41 | * @param _ssel Chip-Select Logic Input of 3-Wire Serial Interface |
| michelebavaro | 0:be1765e9885e | 42 | * Set CS low to allow serial data to shift in. Set CS high |
| michelebavaro | 0:be1765e9885e | 43 | * when the loading action is completed. |
| michelebavaro | 0:be1765e9885e | 44 | */ |
| michelebavaro | 0:be1765e9885e | 45 | MAX2769SSP0(PinName _mosi, PinName _sck, PinName _ssel); |
| michelebavaro | 0:be1765e9885e | 46 | |
| michelebavaro | 0:be1765e9885e | 47 | /** Destructs the MAX2769SSP0 object */ |
| michelebavaro | 0:be1765e9885e | 48 | ~MAX2769SSP0(); |
| michelebavaro | 0:be1765e9885e | 49 | |
| michelebavaro | 0:be1765e9885e | 50 | /** Reads from SSP0 into memory |
| michelebavaro | 0:be1765e9885e | 51 | * |
| michelebavaro | 0:be1765e9885e | 52 | * @param _puiMem Pointer to a 16-bits aligned memory space where data will be written |
| michelebavaro | 0:be1765e9885e | 53 | * @param _iSize Number of locations of the memory to be written |
| michelebavaro | 0:be1765e9885e | 54 | */ |
| michelebavaro | 0:be1765e9885e | 55 | void Read(uint16_t *_puiMem, uint32_t _iLocations); |
| michelebavaro | 0:be1765e9885e | 56 | |
| michelebavaro | 0:be1765e9885e | 57 | }; |
| michelebavaro | 0:be1765e9885e | 58 | #endif /* MAX2769SSP0_H */ |