ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Edit EMAC.h 

Change Latin abbreviation to English phrase and fix capitalization of EMAC while I'm at it.
pull/8560/head
Amanda Butler 2018-10-26 14:53:28 -05:00 committed by kegilbert
parent 4bc7bf3b1e
commit eae570ef08
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
features/netsocket/EMAC.h
View File

@ -26,7 +26,7 @@
/** /**
* This interface should be used to abstract low level access to networking hardware * This interface should be used to abstract low level access to networking hardware
* All operations receive a `void *` HW pointer which an emac device provides when * All operations receive a `void *` hardware pointer which an EMAC device provides when
* it is registered with a stack. * it is registered with a stack.
*/ */
class EMAC { class EMAC {
@ -40,7 +40,7 @@ public:
static EMAC &get_default_instance(); static EMAC &get_default_instance();
/** /**
* Callback to be register with Emac interface and to be called for received packets * Callback to be register with EMAC interface and to be called for received packets
* *
* @param buf Received data * @param buf Received data
*/ */
@ -48,7 +48,7 @@ public:
typedef mbed::Callback<void (emac_mem_buf_t *buf)> emac_link_input_cb_t; typedef mbed::Callback<void (emac_mem_buf_t *buf)> emac_link_input_cb_t;
/** /**
* Callback to be register with Emac interface and to be called for link status changes * Callback to be register with EMAC interface and to be called for link status changes
* *
* @param up Link status * @param up Link status
*/ */
@ -65,7 +65,7 @@ public:
/** /**
* Gets memory buffer alignment preference * Gets memory buffer alignment preference
* *
* Gets preferred memory buffer alignment of the Emac device. IP stack may or may not * Gets preferred memory buffer alignment of the EMAC device. IP stack may or may not
* align link out memory buffer chains using the alignment. * align link out memory buffer chains using the alignment.
* *
* @return Memory alignment requirement in bytes * @return Memory alignment requirement in bytes
@ -107,7 +107,7 @@ public:
* Provided address has to be of correct size, see @a get_hwaddr_size * Provided address has to be of correct size, see @a get_hwaddr_size
* *
* Called to set the MAC address to actually use - if @a get_hwaddr is provided * Called to set the MAC address to actually use - if @a get_hwaddr is provided
* the stack would normally use that, but it could be overridden, e.g. for test * the stack would normally use that, but it could be overridden, for example for test
* purposes. * purposes.
* *
* @param addr Address to be set * @param addr Address to be set