Nico Bollen / LIN

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   MBED_LIN_RGB_Master_Example

LinMaster.h@0:c91a9ebab739, 2014-05-06 (annotated)

Committer:
bollenn
Date:
Tue May 06 19:56:48 2014 +0000
Revision:
0:c91a9ebab739
Child:
1:58b5d1e8fae3
First commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
bollenn 0:c91a9ebab739 1 /**
bollenn 0:c91a9ebab739 2 * Master device LIN communication library for mbed
bollenn 0:c91a9ebab739 3 *
bollenn 0:c91a9ebab739 4 * Copyright (C) 2014 TASS Belgium NV
bollenn 0:c91a9ebab739 5 *
bollenn 0:c91a9ebab739 6 * Released under GPL v2
bollenn 0:c91a9ebab739 7 *
bollenn 0:c91a9ebab739 8 * Other licensing models might apply at the sole discretion of the copyright holders.
bollenn 0:c91a9ebab739 9 *
bollenn 0:c91a9ebab739 10 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
bollenn 0:c91a9ebab739 11 * and associated documentation files (the "Software"), to deal in the Software without restriction,
bollenn 0:c91a9ebab739 12 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
bollenn 0:c91a9ebab739 13 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
bollenn 0:c91a9ebab739 14 * furnished to do so, subject to the following conditions:
bollenn 0:c91a9ebab739 15 *
bollenn 0:c91a9ebab739 16 * The above copyright notice and this permission notice shall be included in all copies or
bollenn 0:c91a9ebab739 17 * substantial portions of the Software.
bollenn 0:c91a9ebab739 18 *
bollenn 0:c91a9ebab739 19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
bollenn 0:c91a9ebab739 20 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
bollenn 0:c91a9ebab739 21 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
bollenn 0:c91a9ebab739 22 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
bollenn 0:c91a9ebab739 23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
bollenn 0:c91a9ebab739 24 */
bollenn 0:c91a9ebab739 25
bollenn 0:c91a9ebab739 26 #include "mbed.h"
bollenn 0:c91a9ebab739 27
bollenn 0:c91a9ebab739 28 class LinMaster
bollenn 0:c91a9ebab739 29 {
bollenn 0:c91a9ebab739 30 public:
bollenn 0:c91a9ebab739 31 /** LIN master constructor
bollenn 0:c91a9ebab739 32 *
bollenn 0:c91a9ebab739 33 * @param Pin The pinname to be used for LIN communication
bollenn 0:c91a9ebab739 34 */
bollenn 0:c91a9ebab739 35 LinMaster(PinName Pin);
bollenn 0:c91a9ebab739 36
bollenn 0:c91a9ebab739 37 /** LIN master destructor */
bollenn 0:c91a9ebab739 38 ~LinMaster();
bollenn 0:c91a9ebab739 39
bollenn 0:c91a9ebab739 40 /** Initialise the LIN module
bollenn 0:c91a9ebab739 41 * - configure IO
bollenn 0:c91a9ebab739 42 * - configure Timer
bollenn 0:c91a9ebab739 43 *
bollenn 0:c91a9ebab739 44 * @return
bollenn 0:c91a9ebab739 45 * true on succes,
bollenn 0:c91a9ebab739 46 * false on fail
bollenn 0:c91a9ebab739 47 */
bollenn 0:c91a9ebab739 48 bool Init(void);
bollenn 0:c91a9ebab739 49
bollenn 0:c91a9ebab739 50 /** Set the LIN baudrate
bollenn 0:c91a9ebab739 51 *
bollenn 0:c91a9ebab739 52 * @param uBaud baudrate value in kbps (1..20000)
bollenn 0:c91a9ebab739 53 * @return
bollenn 0:c91a9ebab739 54 * true on succes,
bollenn 0:c91a9ebab739 55 * false on fail
bollenn 0:c91a9ebab739 56 */
bollenn 0:c91a9ebab739 57 bool Baudrate(uint16_t uBaud);
bollenn 0:c91a9ebab739 58
bollenn 0:c91a9ebab739 59 /** Get the LIN baudrate
bollenn 0:c91a9ebab739 60 *
bollenn 0:c91a9ebab739 61 * @return
bollenn 0:c91a9ebab739 62 * The current configured LIN baudrate
bollenn 0:c91a9ebab739 63 */
bollenn 0:c91a9ebab739 64 uint16_t Baudrate(void);
bollenn 0:c91a9ebab739 65
bollenn 0:c91a9ebab739 66
bollenn 0:c91a9ebab739 67 bool SendFrame(bool blDir, uint8_t u8ID, uint8_t* ptrData, uint8_t u8Len);
bollenn 0:c91a9ebab739 68
bollenn 0:c91a9ebab739 69 private:
bollenn 0:c91a9ebab739 70 uint16_t u16BitPeriod;
bollenn 0:c91a9ebab739 71 uint8_t u8BreakLen;
bollenn 0:c91a9ebab739 72 uint8_t u8DelimLen;
bollenn 0:c91a9ebab739 73 PinName MyPin;
bollenn 0:c91a9ebab739 74 };