Freeman Oldman / NUCLEO_STM32F401RE_CC3000_ILI9341

The code from https://github.com/vpcola/Nucleo

mbed-src/api/CAN.h@0:5464d5e415e5, 2014-10-08 (annotated)

Committer:
sinrab
Date:
Wed Oct 08 11:00:24 2014 +0000
Revision:
0:5464d5e415e5
The code from https://github.com/vpcola/Nucleo

Who changed what in which revision?

UserRevisionLine numberNew contents of line
sinrab 0:5464d5e415e5 1 /* mbed Microcontroller Library
sinrab 0:5464d5e415e5 2 * Copyright (c) 2006-2013 ARM Limited
sinrab 0:5464d5e415e5 3 *
sinrab 0:5464d5e415e5 4 * Licensed under the Apache License, Version 2.0 (the "License");
sinrab 0:5464d5e415e5 5 * you may not use this file except in compliance with the License.
sinrab 0:5464d5e415e5 6 * You may obtain a copy of the License at
sinrab 0:5464d5e415e5 7 *
sinrab 0:5464d5e415e5 8 * http://www.apache.org/licenses/LICENSE-2.0
sinrab 0:5464d5e415e5 9 *
sinrab 0:5464d5e415e5 10 * Unless required by applicable law or agreed to in writing, software
sinrab 0:5464d5e415e5 11 * distributed under the License is distributed on an "AS IS" BASIS,
sinrab 0:5464d5e415e5 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
sinrab 0:5464d5e415e5 13 * See the License for the specific language governing permissions and
sinrab 0:5464d5e415e5 14 * limitations under the License.
sinrab 0:5464d5e415e5 15 */
sinrab 0:5464d5e415e5 16 #ifndef MBED_CAN_H
sinrab 0:5464d5e415e5 17 #define MBED_CAN_H
sinrab 0:5464d5e415e5 18
sinrab 0:5464d5e415e5 19 #include "platform.h"
sinrab 0:5464d5e415e5 20
sinrab 0:5464d5e415e5 21 #if DEVICE_CAN
sinrab 0:5464d5e415e5 22
sinrab 0:5464d5e415e5 23 #include "can_api.h"
sinrab 0:5464d5e415e5 24 #include "can_helper.h"
sinrab 0:5464d5e415e5 25 #include "FunctionPointer.h"
sinrab 0:5464d5e415e5 26
sinrab 0:5464d5e415e5 27 namespace mbed {
sinrab 0:5464d5e415e5 28
sinrab 0:5464d5e415e5 29 /** CANMessage class
sinrab 0:5464d5e415e5 30 */
sinrab 0:5464d5e415e5 31 class CANMessage : public CAN_Message {
sinrab 0:5464d5e415e5 32
sinrab 0:5464d5e415e5 33 public:
sinrab 0:5464d5e415e5 34 /** Creates empty CAN message.
sinrab 0:5464d5e415e5 35 */
sinrab 0:5464d5e415e5 36 CANMessage() : CAN_Message() {
sinrab 0:5464d5e415e5 37 len = 8;
sinrab 0:5464d5e415e5 38 type = CANData;
sinrab 0:5464d5e415e5 39 format = CANStandard;
sinrab 0:5464d5e415e5 40 id = 0;
sinrab 0:5464d5e415e5 41 memset(data, 0, 8);
sinrab 0:5464d5e415e5 42 }
sinrab 0:5464d5e415e5 43
sinrab 0:5464d5e415e5 44 /** Creates CAN message with specific content.
sinrab 0:5464d5e415e5 45 */
sinrab 0:5464d5e415e5 46 CANMessage(int _id, const char *_data, char _len = 8, CANType _type = CANData, CANFormat _format = CANStandard) {
sinrab 0:5464d5e415e5 47 len = _len & 0xF;
sinrab 0:5464d5e415e5 48 type = _type;
sinrab 0:5464d5e415e5 49 format = _format;
sinrab 0:5464d5e415e5 50 id = _id;
sinrab 0:5464d5e415e5 51 memcpy(data, _data, _len);
sinrab 0:5464d5e415e5 52 }
sinrab 0:5464d5e415e5 53
sinrab 0:5464d5e415e5 54 /** Creates CAN remote message.
sinrab 0:5464d5e415e5 55 */
sinrab 0:5464d5e415e5 56 CANMessage(int _id, CANFormat _format = CANStandard) {
sinrab 0:5464d5e415e5 57 len = 0;
sinrab 0:5464d5e415e5 58 type = CANRemote;
sinrab 0:5464d5e415e5 59 format = _format;
sinrab 0:5464d5e415e5 60 id = _id;
sinrab 0:5464d5e415e5 61 memset(data, 0, 8);
sinrab 0:5464d5e415e5 62 }
sinrab 0:5464d5e415e5 63 };
sinrab 0:5464d5e415e5 64
sinrab 0:5464d5e415e5 65 /** A can bus client, used for communicating with can devices
sinrab 0:5464d5e415e5 66 */
sinrab 0:5464d5e415e5 67 class CAN {
sinrab 0:5464d5e415e5 68
sinrab 0:5464d5e415e5 69 public:
sinrab 0:5464d5e415e5 70 /** Creates an CAN interface connected to specific pins.
sinrab 0:5464d5e415e5 71 *
sinrab 0:5464d5e415e5 72 * @param rd read from transmitter
sinrab 0:5464d5e415e5 73 * @param td transmit to transmitter
sinrab 0:5464d5e415e5 74 *
sinrab 0:5464d5e415e5 75 * Example:
sinrab 0:5464d5e415e5 76 * @code
sinrab 0:5464d5e415e5 77 * #include "mbed.h"
sinrab 0:5464d5e415e5 78 *
sinrab 0:5464d5e415e5 79 * Ticker ticker;
sinrab 0:5464d5e415e5 80 * DigitalOut led1(LED1);
sinrab 0:5464d5e415e5 81 * DigitalOut led2(LED2);
sinrab 0:5464d5e415e5 82 * CAN can1(p9, p10);
sinrab 0:5464d5e415e5 83 * CAN can2(p30, p29);
sinrab 0:5464d5e415e5 84 *
sinrab 0:5464d5e415e5 85 * char counter = 0;
sinrab 0:5464d5e415e5 86 *
sinrab 0:5464d5e415e5 87 * void send() {
sinrab 0:5464d5e415e5 88 * if(can1.write(CANMessage(1337, &counter, 1))) {
sinrab 0:5464d5e415e5 89 * printf("Message sent: %d\n", counter);
sinrab 0:5464d5e415e5 90 * counter++;
sinrab 0:5464d5e415e5 91 * }
sinrab 0:5464d5e415e5 92 * led1 = !led1;
sinrab 0:5464d5e415e5 93 * }
sinrab 0:5464d5e415e5 94 *
sinrab 0:5464d5e415e5 95 * int main() {
sinrab 0:5464d5e415e5 96 * ticker.attach(&send, 1);
sinrab 0:5464d5e415e5 97 * CANMessage msg;
sinrab 0:5464d5e415e5 98 * while(1) {
sinrab 0:5464d5e415e5 99 * if(can2.read(msg)) {
sinrab 0:5464d5e415e5 100 * printf("Message received: %d\n\n", msg.data[0]);
sinrab 0:5464d5e415e5 101 * led2 = !led2;
sinrab 0:5464d5e415e5 102 * }
sinrab 0:5464d5e415e5 103 * wait(0.2);
sinrab 0:5464d5e415e5 104 * }
sinrab 0:5464d5e415e5 105 * }
sinrab 0:5464d5e415e5 106 * @endcode
sinrab 0:5464d5e415e5 107 */
sinrab 0:5464d5e415e5 108 CAN(PinName rd, PinName td);
sinrab 0:5464d5e415e5 109 virtual ~CAN();
sinrab 0:5464d5e415e5 110
sinrab 0:5464d5e415e5 111 /** Set the frequency of the CAN interface
sinrab 0:5464d5e415e5 112 *
sinrab 0:5464d5e415e5 113 * @param hz The bus frequency in hertz
sinrab 0:5464d5e415e5 114 *
sinrab 0:5464d5e415e5 115 * @returns
sinrab 0:5464d5e415e5 116 * 1 if successful,
sinrab 0:5464d5e415e5 117 * 0 otherwise
sinrab 0:5464d5e415e5 118 */
sinrab 0:5464d5e415e5 119 int frequency(int hz);
sinrab 0:5464d5e415e5 120
sinrab 0:5464d5e415e5 121 /** Write a CANMessage to the bus.
sinrab 0:5464d5e415e5 122 *
sinrab 0:5464d5e415e5 123 * @param msg The CANMessage to write.
sinrab 0:5464d5e415e5 124 *
sinrab 0:5464d5e415e5 125 * @returns
sinrab 0:5464d5e415e5 126 * 0 if write failed,
sinrab 0:5464d5e415e5 127 * 1 if write was successful
sinrab 0:5464d5e415e5 128 */
sinrab 0:5464d5e415e5 129 int write(CANMessage msg);
sinrab 0:5464d5e415e5 130
sinrab 0:5464d5e415e5 131 /** Read a CANMessage from the bus.
sinrab 0:5464d5e415e5 132 *
sinrab 0:5464d5e415e5 133 * @param msg A CANMessage to read to.
sinrab 0:5464d5e415e5 134 * @param handle message filter handle (0 for any message)
sinrab 0:5464d5e415e5 135 *
sinrab 0:5464d5e415e5 136 * @returns
sinrab 0:5464d5e415e5 137 * 0 if no message arrived,
sinrab 0:5464d5e415e5 138 * 1 if message arrived
sinrab 0:5464d5e415e5 139 */
sinrab 0:5464d5e415e5 140 int read(CANMessage &msg, int handle = 0);
sinrab 0:5464d5e415e5 141
sinrab 0:5464d5e415e5 142 /** Reset CAN interface.
sinrab 0:5464d5e415e5 143 *
sinrab 0:5464d5e415e5 144 * To use after error overflow.
sinrab 0:5464d5e415e5 145 */
sinrab 0:5464d5e415e5 146 void reset();
sinrab 0:5464d5e415e5 147
sinrab 0:5464d5e415e5 148 /** Puts or removes the CAN interface into silent monitoring mode
sinrab 0:5464d5e415e5 149 *
sinrab 0:5464d5e415e5 150 * @param silent boolean indicating whether to go into silent mode or not
sinrab 0:5464d5e415e5 151 */
sinrab 0:5464d5e415e5 152 void monitor(bool silent);
sinrab 0:5464d5e415e5 153
sinrab 0:5464d5e415e5 154 enum Mode {
sinrab 0:5464d5e415e5 155 Reset = 0,
sinrab 0:5464d5e415e5 156 Normal,
sinrab 0:5464d5e415e5 157 Silent,
sinrab 0:5464d5e415e5 158 LocalTest,
sinrab 0:5464d5e415e5 159 GlobalTest,
sinrab 0:5464d5e415e5 160 SilentTest
sinrab 0:5464d5e415e5 161 };
sinrab 0:5464d5e415e5 162
sinrab 0:5464d5e415e5 163 /** Change CAN operation to the specified mode
sinrab 0:5464d5e415e5 164 *
sinrab 0:5464d5e415e5 165 * @param mode The new operation mode (CAN::Normal, CAN::Silent, CAN::LocalTest, CAN::GlobalTest, CAN::SilentTest)
sinrab 0:5464d5e415e5 166 *
sinrab 0:5464d5e415e5 167 * @returns
sinrab 0:5464d5e415e5 168 * 0 if mode change failed or unsupported,
sinrab 0:5464d5e415e5 169 * 1 if mode change was successful
sinrab 0:5464d5e415e5 170 */
sinrab 0:5464d5e415e5 171 int mode(Mode mode);
sinrab 0:5464d5e415e5 172
sinrab 0:5464d5e415e5 173 /** Filter out incomming messages
sinrab 0:5464d5e415e5 174 *
sinrab 0:5464d5e415e5 175 * @param id the id to filter on
sinrab 0:5464d5e415e5 176 * @param mask the mask applied to the id
sinrab 0:5464d5e415e5 177 * @param format format to filter on (Default CANAny)
sinrab 0:5464d5e415e5 178 * @param handle message filter handle (Optional)
sinrab 0:5464d5e415e5 179 *
sinrab 0:5464d5e415e5 180 * @returns
sinrab 0:5464d5e415e5 181 * 0 if filter change failed or unsupported,
sinrab 0:5464d5e415e5 182 * new filter handle if successful
sinrab 0:5464d5e415e5 183 */
sinrab 0:5464d5e415e5 184 int filter(unsigned int id, unsigned int mask, CANFormat format = CANAny, int handle = 0);
sinrab 0:5464d5e415e5 185
sinrab 0:5464d5e415e5 186 /** Returns number of read errors to detect read overflow errors.
sinrab 0:5464d5e415e5 187 */
sinrab 0:5464d5e415e5 188 unsigned char rderror();
sinrab 0:5464d5e415e5 189
sinrab 0:5464d5e415e5 190 /** Returns number of write errors to detect write overflow errors.
sinrab 0:5464d5e415e5 191 */
sinrab 0:5464d5e415e5 192 unsigned char tderror();
sinrab 0:5464d5e415e5 193
sinrab 0:5464d5e415e5 194 enum IrqType {
sinrab 0:5464d5e415e5 195 RxIrq = 0,
sinrab 0:5464d5e415e5 196 TxIrq,
sinrab 0:5464d5e415e5 197 EwIrq,
sinrab 0:5464d5e415e5 198 DoIrq,
sinrab 0:5464d5e415e5 199 WuIrq,
sinrab 0:5464d5e415e5 200 EpIrq,
sinrab 0:5464d5e415e5 201 AlIrq,
sinrab 0:5464d5e415e5 202 BeIrq,
sinrab 0:5464d5e415e5 203 IdIrq
sinrab 0:5464d5e415e5 204 };
sinrab 0:5464d5e415e5 205
sinrab 0:5464d5e415e5 206 /** Attach a function to call whenever a CAN frame received interrupt is
sinrab 0:5464d5e415e5 207 * generated.
sinrab 0:5464d5e415e5 208 *
sinrab 0:5464d5e415e5 209 * @param fptr A pointer to a void function, or 0 to set as none
sinrab 0:5464d5e415e5 210 * @param event Which CAN interrupt to attach the member function to (CAN::RxIrq for message received, CAN::TxIrq for transmitted or aborted, CAN::EwIrq for error warning, CAN::DoIrq for data overrun, CAN::WuIrq for wake-up, CAN::EpIrq for error passive, CAN::AlIrq for arbitration lost, CAN::BeIrq for bus error)
sinrab 0:5464d5e415e5 211 */
sinrab 0:5464d5e415e5 212 void attach(void (*fptr)(void), IrqType type=RxIrq);
sinrab 0:5464d5e415e5 213
sinrab 0:5464d5e415e5 214 /** Attach a member function to call whenever a CAN frame received interrupt
sinrab 0:5464d5e415e5 215 * is generated.
sinrab 0:5464d5e415e5 216 *
sinrab 0:5464d5e415e5 217 * @param tptr pointer to the object to call the member function on
sinrab 0:5464d5e415e5 218 * @param mptr pointer to the member function to be called
sinrab 0:5464d5e415e5 219 * @param event Which CAN interrupt to attach the member function to (CAN::RxIrq for message received, TxIrq for transmitted or aborted, EwIrq for error warning, DoIrq for data overrun, WuIrq for wake-up, EpIrq for error passive, AlIrq for arbitration lost, BeIrq for bus error)
sinrab 0:5464d5e415e5 220 */
sinrab 0:5464d5e415e5 221 template<typename T>
sinrab 0:5464d5e415e5 222 void attach(T* tptr, void (T::*mptr)(void), IrqType type=RxIrq) {
sinrab 0:5464d5e415e5 223 if((mptr != NULL) && (tptr != NULL)) {
sinrab 0:5464d5e415e5 224 _irq[type].attach(tptr, mptr);
sinrab 0:5464d5e415e5 225 can_irq_set(&_can, (CanIrqType)type, 1);
sinrab 0:5464d5e415e5 226 }
sinrab 0:5464d5e415e5 227 else {
sinrab 0:5464d5e415e5 228 can_irq_set(&_can, (CanIrqType)type, 0);
sinrab 0:5464d5e415e5 229 }
sinrab 0:5464d5e415e5 230 }
sinrab 0:5464d5e415e5 231
sinrab 0:5464d5e415e5 232 static void _irq_handler(uint32_t id, CanIrqType type);
sinrab 0:5464d5e415e5 233
sinrab 0:5464d5e415e5 234 protected:
sinrab 0:5464d5e415e5 235 can_t _can;
sinrab 0:5464d5e415e5 236 FunctionPointer _irq[9];
sinrab 0:5464d5e415e5 237 };
sinrab 0:5464d5e415e5 238
sinrab 0:5464d5e415e5 239 } // namespace mbed
sinrab 0:5464d5e415e5 240
sinrab 0:5464d5e415e5 241 #endif
sinrab 0:5464d5e415e5 242
sinrab 0:5464d5e415e5 243 #endif // MBED_CAN_H
sinrab 0:5464d5e415e5 244