mbed library sources
Dependents: frdm_kl05z_gpio_test
Fork of mbed-src by
Diff: cpp/CAN.h
- Revision:
- 2:143cac498751
- Parent:
- 0:fd0d7bdfcdc2
diff -r 62685faffa05 -r 143cac498751 cpp/CAN.h --- a/cpp/CAN.h Thu Nov 29 15:41:14 2012 +0000 +++ b/cpp/CAN.h Mon Feb 18 11:44:18 2013 +0000 @@ -1,23 +1,17 @@ /* mbed Microcontroller Library - * Copyright (c) 2006-2012 ARM Limited + * Copyright (c) 2006-2013 ARM Limited * - * Permission is hereby granted, free of charge, to any person obtaining a copy - * of this software and associated documentation files (the "Software"), to deal - * in the Software without restriction, including without limitation the rights - * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - * copies of the Software, and to permit persons to whom the Software is - * furnished to do so, subject to the following conditions: + * 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 * - * The above copyright notice and this permission notice shall be included in - * all copies or substantial portions of the Software. + * http://www.apache.org/licenses/LICENSE-2.0 * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE - * SOFTWARE. + * 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_CAN_H #define MBED_CAN_H @@ -27,7 +21,7 @@ #if DEVICE_CAN #include "can_api.h" -#include "can_helper.h" +#include "can_helper.h" #include "FunctionPointer.h" namespace mbed { @@ -46,7 +40,7 @@ id = 0; memset(data, 0, 8); } - + /** Creates CAN message with specific content. */ CANMessage(int _id, const char *_data, char _len = 8, CANType _type = CANData, CANFormat _format = CANStandard) { @@ -81,23 +75,23 @@ * Example: * @code * #include "mbed.h" - * + * * Ticker ticker; * DigitalOut led1(LED1); * DigitalOut led2(LED2); * CAN can1(p9, p10); * CAN can2(p30, p29); - * + * * char counter = 0; - * + * * void send() { * if(can1.write(CANMessage(1337, &counter, 1))) { * printf("Message sent: %d\n", counter); * counter++; - * } + * } * led1 = !led1; * } - * + * * int main() { * ticker.attach(&send, 1); * CANMessage msg; @@ -105,15 +99,15 @@ * if(can2.read(msg)) { * printf("Message received: %d\n\n", msg.data[0]); * led2 = !led2; - * } + * } * wait(0.2); * } - * } + * } * @endcode */ CAN(PinName rd, PinName td); virtual ~CAN(); - + /** Set the frequency of the CAN interface * * @param hz The bus frequency in hertz @@ -123,7 +117,7 @@ * 0 otherwise */ int frequency(int hz); - + /** Write a CANMessage to the bus. * * @param msg The CANMessage to write. @@ -133,9 +127,9 @@ * 1 if write was successful */ int write(CANMessage msg); - + /** Read a CANMessage from the bus. - * + * * @param msg A CANMessage to read to. * * @returns @@ -143,19 +137,19 @@ * 1 if message arrived */ int read(CANMessage &msg); - + /** Reset CAN interface. * * To use after error overflow. */ void reset(); - + /** Puts or removes the CAN interface into silent monitoring mode * * @param silent boolean indicating whether to go into silent mode or not */ void monitor(bool silent); - + /** Returns number of read errors to detect read overflow errors. */ unsigned char rderror(); @@ -170,7 +164,7 @@ * @param fptr A pointer to a void function, or 0 to set as none */ void attach(void (*fptr)(void)); - + /** Attach a member function to call whenever a CAN frame received interrupt * is generated. * @@ -186,11 +180,11 @@ remove_interrupt(); } } - + private: can_t _can; FunctionPointer _rxirq; - + void setup_interrupt(void); void remove_interrupt(void); };