Ryo Iizuka / libMiMic

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   MbedFileServer_1768MiniDK2 RedWireBridge IssueDebug_gcc MiMicRemoteMCU-for-Mbed ... more

cpp/NetConfig.h@13:a71705c5e6fd, 2013-04-21 (annotated)

Committer:
nyatla
Date:
Sun Apr 21 01:21:41 2013 +0000
Revision:
13:a71705c5e6fd
Parent:
11:c82a7b2899b0
Child:
14:4618692ec239
a lot changes.; add format text reader. ;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nyatla 3:0a94993be1f6 1 #pragma once
nyatla 3:0a94993be1f6 2 ////////////////////////////////////////////////////////////////////////////////
nyatla 3:0a94993be1f6 3 // NetConfig.h
nyatla 3:0a94993be1f6 4 ////////////////////////////////////////////////////////////////////////////////
nyatla 3:0a94993be1f6 5
nyatla 3:0a94993be1f6 6 #include "NyLPC_net.h"
nyatla 3:0a94993be1f6 7
nyatla 3:0a94993be1f6 8 namespace MiMic
nyatla 3:0a94993be1f6 9 {
nyatla 3:0a94993be1f6 10 /**
nyatla 3:0a94993be1f6 11 * Network configulation class.
nyatla 11:c82a7b2899b0 12 * The class is used for argument of NetConfig constructor.
nyatla 3:0a94993be1f6 13 */
nyatla 3:0a94993be1f6 14 class NetConfig
nyatla 3:0a94993be1f6 15 {
nyatla 3:0a94993be1f6 16 public:
nyatla 3:0a94993be1f6 17 NyLPC_TcNetConfig_t _inst;
nyatla 3:0a94993be1f6 18 public:
nyatla 3:0a94993be1f6 19 /**
nyatla 3:0a94993be1f6 20 * The constructor.
nyatla 3:0a94993be1f6 21 * This function initializes instance by onchip configulation data.
nyatla 3:0a94993be1f6 22 * @param i_is_factory_default
nyatla 11:c82a7b2899b0 23 * Factory default flag.
nyatla 3:0a94993be1f6 24 * <ul>
nyatla 3:0a94993be1f6 25 * <li>true - The function sets factory default setting.
nyatla 3:0a94993be1f6 26 * <li>false -The function sets onchip memory configulation (default)
nyatla 3:0a94993be1f6 27 * </ul>
nyatla 3:0a94993be1f6 28 */
nyatla 3:0a94993be1f6 29 NetConfig(bool i_is_factory_default=false);
nyatla 3:0a94993be1f6 30 virtual ~NetConfig();
nyatla 11:c82a7b2899b0 31 /**
nyatla 11:c82a7b2899b0 32 * Set IPv4 ip address to instance.
nyatla 11:c82a7b2899b0 33 */
nyatla 11:c82a7b2899b0 34 void setIpAddr(unsigned char ip4,unsigned char ip3,unsigned char ip2,unsigned char ip1);
nyatla 11:c82a7b2899b0 35 /**
nyatla 11:c82a7b2899b0 36 * Set IPv4 network mask value to instance.
nyatla 11:c82a7b2899b0 37 */
nyatla 11:c82a7b2899b0 38 void setNetMask(unsigned char ip4,unsigned char ip3,unsigned char ip2,unsigned char ip1);
nyatla 11:c82a7b2899b0 39
nyatla 11:c82a7b2899b0 40 /**
nyatla 11:c82a7b2899b0 41 * Set IPv4 default gateway address to instance.
nyatla 11:c82a7b2899b0 42 */
nyatla 11:c82a7b2899b0 43 void setGateway(unsigned char ip4,unsigned char ip3,unsigned char ip2,unsigned char ip1);
nyatla 11:c82a7b2899b0 44 /**
nyatla 11:c82a7b2899b0 45 * Set ethernet mac address to instance.
nyatla 11:c82a7b2899b0 46 */
nyatla 11:c82a7b2899b0 47 void setEmac(unsigned char ip6,unsigned char ip5,unsigned char ip4,unsigned char ip3,unsigned char ip2,unsigned char ip1);
nyatla 13:a71705c5e6fd 48 /**
nyatla 13:a71705c5e6fd 49 * Load configulation from text file.
nyatla 13:a71705c5e6fd 50 * <p>File format example
nyatla 13:a71705c5e6fd 51 * <pre>
nyatla 13:a71705c5e6fd 52 * macaddr=00:00:00:00:00:00
nyatla 13:a71705c5e6fd 53 * ipaddr=192.168.0.1
nyatla 13:a71705c5e6fd 54 * netmask=255.255.255.0
nyatla 13:a71705c5e6fd 55 * gateway=192.168.0.254
nyatla 13:a71705c5e6fd 56 * </pre>
nyatla 13:a71705c5e6fd 57 * <p>Keys
nyatla 13:a71705c5e6fd 58 * <ul>
nyatla 13:a71705c5e6fd 59 * <li>macaddr=[:macaddr:] - 48bit ethernet mac address that are separated by ':'</li>
nyatla 13:a71705c5e6fd 60 * <li>ipaddr=[:ip:] - 32 bit IP address</li>
nyatla 13:a71705c5e6fd 61 * <li>netmask=[:ip:]- 32 bit network mask value.</li>
nyatla 13:a71705c5e6fd 62 * <li>gateway=[:ip:] - 32 bit default gateway address.</li>
nyatla 13:a71705c5e6fd 63 * </ul>
nyatla 13:a71705c5e6fd 64 * </p>
nyatla 13:a71705c5e6fd 65 * Maximum line length is 31.
nyatla 13:a71705c5e6fd 66 * Specified values are override on-chip setting value.
nyatla 13:a71705c5e6fd 67 * If the same value appeared, then the last one is enabled.
nyatla 13:a71705c5e6fd 68 * </p>
nyatla 13:a71705c5e6fd 69 * @return
nyatla 13:a71705c5e6fd 70 * true if file read. false is not read.
nyatla 13:a71705c5e6fd 71 */
nyatla 13:a71705c5e6fd 72 bool NetConfig::loadFromFile(const char* i_file);
nyatla 13:a71705c5e6fd 73 };
nyatla 13:a71705c5e6fd 74 }