mbed library sources
Fork of mbed-src by
Diff: cpp/Ethernet.h
- Revision:
- 2:143cac498751
- Parent:
- 0:fd0d7bdfcdc2
--- a/cpp/Ethernet.h Thu Nov 29 15:41:14 2012 +0000 +++ b/cpp/Ethernet.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_ETHERNET_H #define MBED_ETHERNET_H @@ -33,14 +27,14 @@ * Example: * @code * // Read destination and source from every ethernet packet - * + * * #include "mbed.h" * * Ethernet eth; - * + * * int main() { * char buf[0x600]; - * + * * while(1) { * int size = eth.receive(); * if(size > 0) { @@ -50,7 +44,7 @@ * printf("Source: %02X:%02X:%02X:%02X:%02X:%02X\n", * buf[6], buf[7], buf[8], buf[9], buf[10], buf[11]); * } - * + * * wait(1); * } * } @@ -59,7 +53,7 @@ class Ethernet { public: - + /** Initialise the ethernet interface. */ Ethernet(); @@ -79,7 +73,7 @@ /** Writes into an outgoing ethernet packet. * * It will append size bytes of data to the previously written bytes. - * + * * @param data An array to write. * @param size The size of data. * @@ -101,7 +95,7 @@ /** Recevies an arrived ethernet packet. * - * Receiving an ethernet packet will drop the last received ethernet packet + * Receiving an ethernet packet will drop the last received ethernet packet * and make a new ethernet packet ready to read. * If no ethernet packet is arrived it will return 0. * @@ -117,14 +111,14 @@ * possible to read bytes from this packet. * Read will write up to size bytes into data. * - * It is possible to use read multible times. + * It is possible to use read multible times. * Each time read will start reading after the last read byte before. * * @returns * The number of byte read. */ int read(char *data, int size); - + /** Gives the ethernet address of the mbed. * * @param mac Must be a pointer to a 6 byte char array to copy the ethernet address in. @@ -132,7 +126,7 @@ void address(char *mac); /** Returns if an ethernet link is pressent or not. It takes a wile after Ethernet initializion to show up. - * + * * @returns * 0 if no ethernet link is pressent, * 1 if an ethernet link is pressent. @@ -141,7 +135,7 @@ * @code * // Using the Ethernet link function * #include "mbed.h" - * + * * Ethernet eth; * * int main() {