kushagra brahmbhatt / IoT_Security

IoT Home Alarm System

Dependents:   IoTBurglar_and_Fire_AlarmSystem

Ethernet.h@0:2f388b030837, 2016-04-29 (annotated)

Committer:
kbrahmbhatt6
Date:
Fri Apr 29 06:59:59 2016 +0000
Revision:
0:2f388b030837
1

Who changed what in which revision?

UserRevisionLine numberNew contents of line
kbrahmbhatt6 0:2f388b030837 1 /* mbed Microcontroller Library
kbrahmbhatt6 0:2f388b030837 2 * Copyright (c) 2006-2013 ARM Limited
kbrahmbhatt6 0:2f388b030837 3 *
kbrahmbhatt6 0:2f388b030837 4 * Licensed under the Apache License, Version 2.0 (the "License");
kbrahmbhatt6 0:2f388b030837 5 * you may not use this file except in compliance with the License.
kbrahmbhatt6 0:2f388b030837 6 * You may obtain a copy of the License at
kbrahmbhatt6 0:2f388b030837 7 *
kbrahmbhatt6 0:2f388b030837 8 * http://www.apache.org/licenses/LICENSE-2.0
kbrahmbhatt6 0:2f388b030837 9 *
kbrahmbhatt6 0:2f388b030837 10 * Unless required by applicable law or agreed to in writing, software
kbrahmbhatt6 0:2f388b030837 11 * distributed under the License is distributed on an "AS IS" BASIS,
kbrahmbhatt6 0:2f388b030837 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
kbrahmbhatt6 0:2f388b030837 13 * See the License for the specific language governing permissions and
kbrahmbhatt6 0:2f388b030837 14 * limitations under the License.
kbrahmbhatt6 0:2f388b030837 15 */
kbrahmbhatt6 0:2f388b030837 16 #ifndef MBED_ETHERNET_H
kbrahmbhatt6 0:2f388b030837 17 #define MBED_ETHERNET_H
kbrahmbhatt6 0:2f388b030837 18
kbrahmbhatt6 0:2f388b030837 19 #include "platform.h"
kbrahmbhatt6 0:2f388b030837 20
kbrahmbhatt6 0:2f388b030837 21 #if DEVICE_ETHERNET
kbrahmbhatt6 0:2f388b030837 22
kbrahmbhatt6 0:2f388b030837 23 namespace mbed {
kbrahmbhatt6 0:2f388b030837 24
kbrahmbhatt6 0:2f388b030837 25 /** An ethernet interface, to use with the ethernet pins.
kbrahmbhatt6 0:2f388b030837 26 *
kbrahmbhatt6 0:2f388b030837 27 * Example:
kbrahmbhatt6 0:2f388b030837 28 * @code
kbrahmbhatt6 0:2f388b030837 29 * // Read destination and source from every ethernet packet
kbrahmbhatt6 0:2f388b030837 30 *
kbrahmbhatt6 0:2f388b030837 31 * #include "mbed.h"
kbrahmbhatt6 0:2f388b030837 32 *
kbrahmbhatt6 0:2f388b030837 33 * Ethernet eth;
kbrahmbhatt6 0:2f388b030837 34 *
kbrahmbhatt6 0:2f388b030837 35 * int main() {
kbrahmbhatt6 0:2f388b030837 36 * char buf[0x600];
kbrahmbhatt6 0:2f388b030837 37 *
kbrahmbhatt6 0:2f388b030837 38 * while(1) {
kbrahmbhatt6 0:2f388b030837 39 * int size = eth.receive();
kbrahmbhatt6 0:2f388b030837 40 * if(size > 0) {
kbrahmbhatt6 0:2f388b030837 41 * eth.read(buf, size);
kbrahmbhatt6 0:2f388b030837 42 * printf("Destination: %02X:%02X:%02X:%02X:%02X:%02X\n",
kbrahmbhatt6 0:2f388b030837 43 * buf[0], buf[1], buf[2], buf[3], buf[4], buf[5]);
kbrahmbhatt6 0:2f388b030837 44 * printf("Source: %02X:%02X:%02X:%02X:%02X:%02X\n",
kbrahmbhatt6 0:2f388b030837 45 * buf[6], buf[7], buf[8], buf[9], buf[10], buf[11]);
kbrahmbhatt6 0:2f388b030837 46 * }
kbrahmbhatt6 0:2f388b030837 47 *
kbrahmbhatt6 0:2f388b030837 48 * wait(1);
kbrahmbhatt6 0:2f388b030837 49 * }
kbrahmbhatt6 0:2f388b030837 50 * }
kbrahmbhatt6 0:2f388b030837 51 * @endcode
kbrahmbhatt6 0:2f388b030837 52 */
kbrahmbhatt6 0:2f388b030837 53 class Ethernet {
kbrahmbhatt6 0:2f388b030837 54
kbrahmbhatt6 0:2f388b030837 55 public:
kbrahmbhatt6 0:2f388b030837 56
kbrahmbhatt6 0:2f388b030837 57 /** Initialise the ethernet interface.
kbrahmbhatt6 0:2f388b030837 58 */
kbrahmbhatt6 0:2f388b030837 59 Ethernet();
kbrahmbhatt6 0:2f388b030837 60
kbrahmbhatt6 0:2f388b030837 61 /** Powers the hardware down.
kbrahmbhatt6 0:2f388b030837 62 */
kbrahmbhatt6 0:2f388b030837 63 virtual ~Ethernet();
kbrahmbhatt6 0:2f388b030837 64
kbrahmbhatt6 0:2f388b030837 65 enum Mode {
kbrahmbhatt6 0:2f388b030837 66 AutoNegotiate,
kbrahmbhatt6 0:2f388b030837 67 HalfDuplex10,
kbrahmbhatt6 0:2f388b030837 68 FullDuplex10,
kbrahmbhatt6 0:2f388b030837 69 HalfDuplex100,
kbrahmbhatt6 0:2f388b030837 70 FullDuplex100
kbrahmbhatt6 0:2f388b030837 71 };
kbrahmbhatt6 0:2f388b030837 72
kbrahmbhatt6 0:2f388b030837 73 /** Writes into an outgoing ethernet packet.
kbrahmbhatt6 0:2f388b030837 74 *
kbrahmbhatt6 0:2f388b030837 75 * It will append size bytes of data to the previously written bytes.
kbrahmbhatt6 0:2f388b030837 76 *
kbrahmbhatt6 0:2f388b030837 77 * @param data An array to write.
kbrahmbhatt6 0:2f388b030837 78 * @param size The size of data.
kbrahmbhatt6 0:2f388b030837 79 *
kbrahmbhatt6 0:2f388b030837 80 * @returns
kbrahmbhatt6 0:2f388b030837 81 * The number of written bytes.
kbrahmbhatt6 0:2f388b030837 82 */
kbrahmbhatt6 0:2f388b030837 83 int write(const char *data, int size);
kbrahmbhatt6 0:2f388b030837 84
kbrahmbhatt6 0:2f388b030837 85 /** Send an outgoing ethernet packet.
kbrahmbhatt6 0:2f388b030837 86 *
kbrahmbhatt6 0:2f388b030837 87 * After filling in the data in an ethernet packet it must be send.
kbrahmbhatt6 0:2f388b030837 88 * Send will provide a new packet to write to.
kbrahmbhatt6 0:2f388b030837 89 *
kbrahmbhatt6 0:2f388b030837 90 * @returns
kbrahmbhatt6 0:2f388b030837 91 * 0 if the sending was failed,
kbrahmbhatt6 0:2f388b030837 92 * or the size of the packet successfully sent.
kbrahmbhatt6 0:2f388b030837 93 */
kbrahmbhatt6 0:2f388b030837 94 int send();
kbrahmbhatt6 0:2f388b030837 95
kbrahmbhatt6 0:2f388b030837 96 /** Recevies an arrived ethernet packet.
kbrahmbhatt6 0:2f388b030837 97 *
kbrahmbhatt6 0:2f388b030837 98 * Receiving an ethernet packet will drop the last received ethernet packet
kbrahmbhatt6 0:2f388b030837 99 * and make a new ethernet packet ready to read.
kbrahmbhatt6 0:2f388b030837 100 * If no ethernet packet is arrived it will return 0.
kbrahmbhatt6 0:2f388b030837 101 *
kbrahmbhatt6 0:2f388b030837 102 * @returns
kbrahmbhatt6 0:2f388b030837 103 * 0 if no ethernet packet is arrived,
kbrahmbhatt6 0:2f388b030837 104 * or the size of the arrived packet.
kbrahmbhatt6 0:2f388b030837 105 */
kbrahmbhatt6 0:2f388b030837 106 int receive();
kbrahmbhatt6 0:2f388b030837 107
kbrahmbhatt6 0:2f388b030837 108 /** Read from an recevied ethernet packet.
kbrahmbhatt6 0:2f388b030837 109 *
kbrahmbhatt6 0:2f388b030837 110 * After receive returnd a number bigger than 0it is
kbrahmbhatt6 0:2f388b030837 111 * possible to read bytes from this packet.
kbrahmbhatt6 0:2f388b030837 112 * Read will write up to size bytes into data.
kbrahmbhatt6 0:2f388b030837 113 *
kbrahmbhatt6 0:2f388b030837 114 * It is possible to use read multible times.
kbrahmbhatt6 0:2f388b030837 115 * Each time read will start reading after the last read byte before.
kbrahmbhatt6 0:2f388b030837 116 *
kbrahmbhatt6 0:2f388b030837 117 * @returns
kbrahmbhatt6 0:2f388b030837 118 * The number of byte read.
kbrahmbhatt6 0:2f388b030837 119 */
kbrahmbhatt6 0:2f388b030837 120 int read(char *data, int size);
kbrahmbhatt6 0:2f388b030837 121
kbrahmbhatt6 0:2f388b030837 122 /** Gives the ethernet address of the mbed.
kbrahmbhatt6 0:2f388b030837 123 *
kbrahmbhatt6 0:2f388b030837 124 * @param mac Must be a pointer to a 6 byte char array to copy the ethernet address in.
kbrahmbhatt6 0:2f388b030837 125 */
kbrahmbhatt6 0:2f388b030837 126 void address(char *mac);
kbrahmbhatt6 0:2f388b030837 127
kbrahmbhatt6 0:2f388b030837 128 /** Returns if an ethernet link is pressent or not. It takes a wile after Ethernet initializion to show up.
kbrahmbhatt6 0:2f388b030837 129 *
kbrahmbhatt6 0:2f388b030837 130 * @returns
kbrahmbhatt6 0:2f388b030837 131 * 0 if no ethernet link is pressent,
kbrahmbhatt6 0:2f388b030837 132 * 1 if an ethernet link is pressent.
kbrahmbhatt6 0:2f388b030837 133 *
kbrahmbhatt6 0:2f388b030837 134 * Example:
kbrahmbhatt6 0:2f388b030837 135 * @code
kbrahmbhatt6 0:2f388b030837 136 * // Using the Ethernet link function
kbrahmbhatt6 0:2f388b030837 137 * #include "mbed.h"
kbrahmbhatt6 0:2f388b030837 138 *
kbrahmbhatt6 0:2f388b030837 139 * Ethernet eth;
kbrahmbhatt6 0:2f388b030837 140 *
kbrahmbhatt6 0:2f388b030837 141 * int main() {
kbrahmbhatt6 0:2f388b030837 142 * wait(1); // Needed after startup.
kbrahmbhatt6 0:2f388b030837 143 * if (eth.link()) {
kbrahmbhatt6 0:2f388b030837 144 * printf("online\n");
kbrahmbhatt6 0:2f388b030837 145 * } else {
kbrahmbhatt6 0:2f388b030837 146 * printf("offline\n");
kbrahmbhatt6 0:2f388b030837 147 * }
kbrahmbhatt6 0:2f388b030837 148 * }
kbrahmbhatt6 0:2f388b030837 149 * @endcode
kbrahmbhatt6 0:2f388b030837 150 */
kbrahmbhatt6 0:2f388b030837 151 int link();
kbrahmbhatt6 0:2f388b030837 152
kbrahmbhatt6 0:2f388b030837 153 /** Sets the speed and duplex parameters of an ethernet link
kbrahmbhatt6 0:2f388b030837 154 *
kbrahmbhatt6 0:2f388b030837 155 * - AutoNegotiate Auto negotiate speed and duplex
kbrahmbhatt6 0:2f388b030837 156 * - HalfDuplex10 10 Mbit, half duplex
kbrahmbhatt6 0:2f388b030837 157 * - FullDuplex10 10 Mbit, full duplex
kbrahmbhatt6 0:2f388b030837 158 * - HalfDuplex100 100 Mbit, half duplex
kbrahmbhatt6 0:2f388b030837 159 * - FullDuplex100 100 Mbit, full duplex
kbrahmbhatt6 0:2f388b030837 160 *
kbrahmbhatt6 0:2f388b030837 161 * @param mode the speed and duplex mode to set the link to:
kbrahmbhatt6 0:2f388b030837 162 */
kbrahmbhatt6 0:2f388b030837 163 void set_link(Mode mode);
kbrahmbhatt6 0:2f388b030837 164 };
kbrahmbhatt6 0:2f388b030837 165
kbrahmbhatt6 0:2f388b030837 166 } // namespace mbed
kbrahmbhatt6 0:2f388b030837 167
kbrahmbhatt6 0:2f388b030837 168 #endif
kbrahmbhatt6 0:2f388b030837 169
kbrahmbhatt6 0:2f388b030837 170 #endif