├── EthernetFrame.xlsx ├── Examples.txt ├── LICENSE ├── NetCFG1.F ├── NetCFG2.F ├── NetNIGE.F ├── NetVFX.F ├── Network.F ├── README.md ├── TestSim1.F ├── TestSim2.F └── VierteDimensionListings ├── API.f ├── ARP.f ├── checksum.f ├── data_structures.f ├── netNIGE.f └── stack.f /EthernetFrame.xlsx: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Anding/Minimal_IP/d0885be451968f592e4d979e068e216c02e83190/EthernetFrame.xlsx -------------------------------------------------------------------------------- /Examples.txt: -------------------------------------------------------------------------------- 1 | Example Ethernet frames 2 | 3 | APR requests 4 | ffffffffffff6cf049eef42a080600010800060400016cf049eef42aC0A80101000000000000C0A80163 5 | ffffffffffff7df049eef43b080600010800060400017df049eef43bC0A8010a000000000000C0A80163 6 | 7 | UDP 8 | 00507f7c9ab06cf049eef42a0800450000506c4700008011CD4Cc0a801123a13053cee4d2003003c01576000000000003b15200100009d3890d734d40d322df94366200100009d386abd087edffcc5ecfac30104e26bb6bf040400000000 9 | 00507f7c9ab06cf049eef42a0800450000502854000080110000c0a80112b06bde31f526cfcd003c50a56000000000003b15200100009d386ab8283706592df94366200100005ef579fb2c0330324f9421ce0104319dae33040400000000 10 | 11 | IP with checksum b1e6 12 | 00507f7c9ab06cf049eef42a08004500003c1c4640004006b1e6ac100a63ac100a0c 13 | 14 | IP with checksum set to zero (computes as b1e6) 15 | 00507f7c9ab06cf049eef42a08004500003c1c46400040060000ac100a63ac100a0c -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /NetCFG1.F: -------------------------------------------------------------------------------- 1 | \ Network configuration file #1 for N.I.G.E. Machine 2 | 3 | \ Network configuration 4 | hex 5 | 02 4e 49 47 45 01 setMAC \ 02 (indicates a locally administered MAC) + 4e 49 47 45 (ASCII "NIGE") + 01 6 | 7 | decimal 8 | 255 255 255 0 setSubnet \ check this setting with the local network router 9 | 192 168 1 1 setRouter \ " " 10 | 192 168 1 101 setIP \ fixed IP address, need to check no conflicts 11 | 12 | \ Initialize network communications 13 | : debugEthernet 14 | \ >remote \ uncomment this line to send output to the RS232 serial port instead of the screen 15 | EthernetReceiveTask 16 | ; 17 | 18 | : start-test 19 | 0 ['] debugEthernet ( n XT) RUN ( task# true | false) 20 | CR IF ." EthernetReceiveTask is " . ELSE ." New task failed" THEN 21 | ; 22 | 23 | \ UDP experiments 24 | 192 168 1 102 setUDPdestIP \ set this to the IP of the partner machine 25 | 5000 UDPsrcPort w! \ source port of outgoing frames. Word length: MUST USE W! \ W@ 26 | 5000 UDPdestPort w! \ destination port of outgoing frames. Word length: MUST USE W! \ W@ 27 | 28 | start-test 29 | 30 | \ outgoing UDP datagram usage 31 | \ s" My message" (addr n --) UDP.send 32 | 33 | \ by default incoming UDP datagrams will be typed if their destination port = UDPsrcPort 34 | \ otherwise adapt UDP.in for the intended application -------------------------------------------------------------------------------- /NetCFG2.F: -------------------------------------------------------------------------------- 1 | \ Network configuration file #2 for N.I.G.E. Machine 2 | 3 | \ Network configuration 4 | hex 5 | 02 4e 49 47 45 02 setMAC \ 02 (indicates a locally administered MAC) + 4e 49 47 45 (ASCII "NIGE") + 02 6 | 7 | decimal 8 | 255 255 255 0 setSubnet \ check this setting with the local network router 9 | 192 168 1 1 setRouter \ " " 10 | 192 168 1 102 setIP \ fixed IP address, need to check no conflicts 11 | 12 | \ Initialize network communications 13 | : debugEthernet 14 | \ >remote \ uncomment this line to send output to the RS232 serial port instead of the screen 15 | EthernetReceiveTask 16 | ; 17 | 18 | : start-test 19 | 0 ['] debugEthernet ( n XT) RUN ( task# true | false) 20 | CR IF ." EthernetReceiveTask is " . ELSE ." New task failed" THEN 21 | ; 22 | 23 | \ UDP experiments 24 | 192 168 1 101 setUDPdestIP \ set this to the IP of the partner machine 25 | 5000 UDPsrcPort w! \ source port of outgoing frames. Word length: MUST USE W! \ W@ 26 | 5000 UDPdestPort w! \ destination port of outgoing frames. Word length: MUST USE W! \ W@ 27 | 28 | start-test 29 | 30 | \ outgoing UDP datagram usage 31 | \ s" My message" (addr n --) UDP.send 32 | 33 | \ by default incoming UDP datagrams will be typed if their destination port = UDPsrcPort 34 | \ otherwise adapt UDP.in for the intended application -------------------------------------------------------------------------------- /NetNIGE.F: -------------------------------------------------------------------------------- 1 | \ Include this file before Network.F 2 | 3 | \ .............................................................................................................. 4 | \ Hardware specific (N.I.G.E. Machine).......................................................................... 5 | hex 6 | 03f860 constant MACreadyRX 7 | 03f864 constant MACdataRX 8 | 03f868 constant MACchecksum_err 9 | 03f86c constant MACreadyTX 10 | 03f870 constant MACdataTX 11 | 03f874 constant MACtransmit_req 12 | 03F828 constant msCounter 13 | decimal 14 | 15 | : getFrame ( frame -- ) 16 | \ wait for an incoming Ethernet frame and place it into inFrame 17 | BEGIN 18 | \ wait for an incoming frame 19 | BEGIN 20 | MACreadyRX @ 21 | pause 22 | UNTIL 23 | \ copy the incoming frame from the FIFO buffer to local storage 24 | dup 1518 + swap DO \ maximum 1518 bytes of data may be copied 25 | MACdataRX @ i c! 26 | MACreadyRX @ 0= IF LEAVE THEN \ ... but exit as soon as the FIFO is empty 27 | LOOP 28 | MACchecksum_err @ not \ confirm checksum validity 29 | UNTIL 30 | ; 31 | 32 | : putFrame ( frame len --) 33 | \ wait until MAC controller is free and then send the Ethernet frame of length len 34 | \ the Ethernet CRC checksum will be computed in hardware by the MAC controller 35 | 36 | \ wait for any existing transmission to complete 37 | BEGIN 38 | MACreadyTX @ 39 | pause 40 | UNTIL 41 | \ transfer the frame to the FIFO buffer 42 | over + swap DO 43 | i C@ MACdataTX C! 44 | LOOP 45 | \ signal the MAC controller to transmit 46 | 0 MACtransmit_req ! 47 | ; 48 | 49 | : ticks ( -- ms) 50 | \ return the ms count 51 | msCounter @ 52 | ; 53 | 54 | : erase ( addr n --) 55 | \ write 0 to n bytes from addr 56 | over + swap DO 57 | 0 i c! 58 | LOOP 59 | ; 60 | -------------------------------------------------------------------------------- /NetVFX.F: -------------------------------------------------------------------------------- 1 | \ Include this file before Network.F 2 | 3 | \ .............................................................................................................. 4 | \ Hardware specific (VFX stubs)................................................................................. 5 | 6 | : getFrame ( frame -- ) 7 | \ wait for an incoming Ethernet frame and copy it to frame 8 | drop 9 | ; 10 | 11 | : putFrame ( frame len --) 12 | \ wait until MAC controller is free and then send the Ethernet frame of length len 13 | \ the Ethernet CRC checksum will be computed in hardware by the MAC controller 14 | drop drop 15 | ; 16 | 17 | : ACQUIRE ( semaphore --) 18 | drop 19 | ; 20 | 21 | : RELEASE ( sempahore --) 22 | drop 23 | ; 24 | 25 | \ .............................................................................................................. 26 | \ Debugging .................................................................................................... 27 | 28 | : parseFrame ( frame --) 29 | \ Parse a hex string (e.g. copied from wireshark) and place it into frame 30 | \ Requires that BASE already be hexadecimal 31 | \ Example usage: 32 | \ hex inFrame parseFRAME ffffffffffff6cf049eef42a080600010800060400016cf049eef42ac0a80112000000000000c0a80101 33 | BL word ( frame caddr) 34 | dup c@ 1 rshift ( frame caddr bytes) 35 | rot dup rot + swap DO 36 | 2 over c! ( caddr) \ make a counted string of length 2 37 | dup NUMBER? 38 | IF i c! ELSE CR ." parse failed" abort THEN 39 | 2+ 40 | LOOP 41 | drop 42 | ; 43 | -------------------------------------------------------------------------------- /Network.F: -------------------------------------------------------------------------------- 1 | \ Mimimal UDP/IP stack 2 | \ Andrew Read June 2016 3 | 4 | \ .............................................................................................................. 5 | \ Description .................................................................................................. 6 | \ This is a "minimal" implementaton of a UDP/IP stack. UDP, IP and ARP are implemented except as noted below 7 | \ The code is designed for the N.I.G.E. Machine but should be suitable for other systems that have 8 | \ (a) multitasking (we require two tasks) 9 | \ (b) ANSI Forth 10 | \ (c) an Ethernet MAC controller (accessed via the functions below) 11 | \ 12 | \ ticks ( -- ms, provide the system timer counter values in milliseconds) 13 | \ getFrame ( frame -- , wait for an incoming Ethernet frame and copy it to frame) 14 | \ putFrame ( frame len -- , send the Ethernet frame of length len to the MAC controller) 15 | \ we assume that the Ethernet CRC checksum will be computed in hardware by the MAC controller 16 | 17 | \ The Forth system assesses the UDP/IP stack with the words UDP.send and UDP.in (see the code). Otherwise there 18 | \ are no generic 'sockets' or API. Words are provided for datagram inspection, etc.. See the section 'debugging' 19 | \ Features not implemented (among other): ICMP, DHCP, IP loopback (127.x.x.x), IP fragmentation 20 | 21 | \ .............................................................................................................. 22 | \ Implementation notes... ...................................................................................... 23 | \ 1.This implementation is multitasking but it is not based on the client server model. There are two tasks, 24 | \ one to handle incoming frames (all the way up the protocol stack) and one to handle outgoing frames (all the 25 | \ way down the protocol stack). Each incoming / outgoing frame must be completely processed before the next. 26 | \ 2. We reserve space for a single incoming frame and a single frame for each top level protocol (UDP, ARP) 27 | \ The MAC controller FIFO buffers provide an additional buffer of one frame in each direction 28 | \ 3. MAC and IP addresses are stored as a sequence of bytes in network (big) endian. They are always referenced by 29 | \ pointer never held on the stack 30 | \ 4. The internet checksum routine assumes a cell size of not less that 32 bits 31 | 32 | decimal 33 | \ .............................................................................................................. 34 | \ Host data .................................................................................................... 35 | create inFrame 1518 allot \ An incoming Ethernet frame. 14 + 1500 + 4 bytes maximum 36 | create UDPframe 1518 allot \ An outgoing UDP frame 37 | create ARPframe 1518 allot \ An outgoing ARP frame 38 | 39 | create hostMAC 6 allot \ Host MAC address 40 | create hostIP 4 allot \ Host IP address 41 | create subnet 4 allot \ Host's local network subnet mask 42 | create router 4 allot \ Host's local network router IP 43 | 44 | \ ARP chache is a simple array with space for 8 entries for 45 | \ IP address (4 bytes), MAC address (6 bytes), timestamp (4 bytes) 46 | create ARPcache 112 allot \ 112 = 14 * 8 47 | variable ARPsemaphore 0 ARPsemaphore ! 48 | 49 | \ .............................................................................................................. 50 | \ Helper words ................................................................................................. 51 | 52 | create MACbroadcast 255 c, 255 c, 255 c, 255 c, 255 c, 255 c, 53 | create MACempty 00 c, 00 c, 00 c, 00 c, 00 c, 00 c, 54 | create ARPheader 00 c, 01 c, 08 c, 00 c, 06 c, 04 c, 55 | 56 | arpcache 0 over ! 1 over c! w@ 1 AND 1- ( 0 | -1) \ use ARPcache as a scratch 57 | constant endian \ endian returns TRUE on a big endian machine and FALSE on a little endian machine 58 | 59 | : w@n ( addr -- u) 60 | \ read a 16 bit word in network endian format 61 | \ this word can be used on both big and little endian machines. 62 | \ alternatively on big endian machines, simply use w@ 63 | dup c@ 256 * ( addr hh00) \ high byte in network endian 64 | swap 1+ c@ + ( hhll) \ low byte 65 | ; 66 | 67 | : w!n ( u addr --) 68 | \ write a 16 bit word in network endian format 69 | \ this word can be used on both big and little endian machines. 70 | \ alternatively on big endian machines, simply use w! 71 | over 8 rshift over c! 72 | 1 + c! 73 | ; 74 | 75 | : mem= ( addr1 addr2 n -- flag) 76 | \ compare n bytes of data at two memory locations 77 | over + swap DO 78 | dup c@ i c@ = not IF drop unloop 0 exit THEN 79 | 1+ 80 | LOOP 81 | drop -1 82 | ; 83 | 84 | : MAC= ( MAC1 MAC2 -- flag) 85 | \ compare two MAC addresses referenced by pointers 86 | 6 mem= 87 | ; 88 | 89 | : IP= ( IP1 IP2 -- flag) 90 | \ compare two IP addresses referenced by pointers 91 | 4 mem= 92 | ; 93 | 94 | : checksum-add ( sum addr n -- sum) 95 | \ Sum over 16 bit words in a 32 bit cell and accumulate to sum. 96 | \ Checksum calculations are performed in the natural endian of the machine for speed. 97 | \ Hence need to check machine endian to deal with any odd byte 98 | \ sum over complete words 99 | >R BEGIN ( sum addr R:n) 100 | R@ 1 > 101 | WHILE 102 | dup w@ ( sum addr u) 103 | rot + swap ( sum' addr) 104 | 2 + ( sum' addr') 105 | R> 2 - >R \ decrement n 106 | REPEAT R> ( sum addr 0|1) 107 | \ deal with any left over byte 108 | IF C@ endian IF 256 * THEN + 109 | ELSE drop THEN ( sum) 110 | ; 111 | 112 | : checksum-add&move ( sum src dst n -- sum) 113 | \ as checksum-add but move the data from src to dst at the same time 114 | \ sum over complete words 115 | swap >R >R BEGIN ( sum src R:dst n) 116 | R@ 1 > 117 | WHILE 118 | dup w@ ( sum src u R:dst n) \ read the word 119 | R> 2 - -rot ( sum n' src u R:dst) \ decrement n 120 | R> over over w! ( sum n' src u dst) \ copy the word to dst 121 | 2 + >R rot >R ( sum src u R:dst' n) \ increment dst 122 | rot + swap ( sum' src R:dst' n) \ accumulate to sum 123 | 2 + ( sum' src' R:dst' n) \ increment src 124 | REPEAT R> ( sum addr 0|1 R:dst) 125 | \ deal with any left over byte 126 | IF 127 | c@ dup R> c! ( sum u) \ copy the byte to dst 128 | endian IF 256 * THEN 129 | + ( sum) \ accumulate to sum 130 | ELSE 131 | R> drop drop 132 | THEN ( sum) 133 | ; 134 | 135 | : checksum-fold ( sum -- checksum) 136 | \ fold the accumulated carry in a 32 bit-cell back into the 16 bit sum 137 | BEGIN ( sum) 138 | dup 139 | 16 Rshift dup ( sum sum>>16 sum>>16) 140 | WHILE 141 | swap 65535 and ( sum>>16 sumAND0xffff) 142 | + 143 | REPEAT 144 | drop ( sum) 145 | \ invert 16 bit checksum 146 | NOT 65535 and ( x) 147 | \ 0x0000 and 0xffff both stand for 0 in ones's complement: exchange the latter for the former 148 | dup 65535 = IF drop 0 THEN 149 | ; 150 | 151 | : checksum ( addr n -- x) 152 | \ return the internet checksum for n bytes starting at addr 153 | \ routine adapted from https://tools.ietf.org/html/rfc1071 154 | 0 -rot ( 0 addr n) 155 | checksum-add 156 | checksum-fold 157 | ; 158 | 159 | \ .............................................................................................................. 160 | \ Debugging ................................................................................................... 161 | 162 | : .MAC ( MAC --) 163 | \ print the MAC address at MAC 164 | 6 0 DO 165 | dup i + c@ 2 .r 166 | i 5 < IF ." :" THEN 167 | LOOP 168 | drop 169 | ; 170 | 171 | : .IP ( IP --) 172 | \ print the IP address at IP 173 | 4 0 DO 174 | dup i + c@ 3 .r 175 | i 3 < IF ." ." THEN 176 | LOOP 177 | drop 178 | ; 179 | 180 | : .EthernetFields ( frame --) 181 | \ print the Ethernet fields in frame 182 | CR ." Ethernet " 183 | CR ." Destination MAC " dup .MAC 184 | CR ." Source MAC " dup 6 + .MAC 185 | CR ." Ethernet type " dup 12 + w@n 2 .r 186 | drop 187 | ; 188 | 189 | : .IPfields ( frame --) 190 | \ print all of the IP fields in frame 191 | CR ." IP " 192 | CR ." Version & IHL " dup 14 + c@ . 193 | CR ." DS & ECN " dup 15 + c@ . 194 | CR ." Length " dup 16 + w@n . 195 | CR ." Identification " dup 18 + w@n . 196 | CR ." Flags & frament offset " dup 20 + w@n . 197 | CR ." Time to live " dup 22 + c@ . 198 | CR ." Protocol " dup 23 + c@ . 199 | CR ." Checksum " dup 24 + w@n . 200 | CR ." Source IP address " dup 26 + .IP 201 | CR ." Destination IP address " dup 30 + .IP 202 | drop 203 | ; 204 | 205 | : .UDPfields ( frame --) 206 | \ Print all of the UDP fields in frame 207 | CR ." UDP " 208 | CR ." Source port " dup 34 + w@n . 209 | CR ." Destination port " dup 36 + w@n . 210 | CR ." Length " dup 38 + w@n . 211 | CR ." Checksum " dup 40 + w@n . 212 | drop 213 | ; 214 | 215 | : .ARPfields ( frame --) 216 | \ Print all of the ARP fields in a frame 217 | CR ." ARP" 218 | CR ." Opcode " dup 20 + w@n . 219 | CR ." Sender's MAC " dup 22 + .MAC 220 | CR ." Sender's IP " dup 28 + .IP 221 | CR ." Target MAC " dup 32 + .MAC 222 | CR ." Target IP " dup 38 + .IP 223 | drop 224 | ; 225 | 226 | : .ARPcache ( --) 227 | \ Print the ARP cache in the format IP, MAC, timestamp 228 | ARPcache dup 112 + swap DO 229 | CR i .IP 9 emit i 4 + .MAC 9 emit i 10 + @ u. 230 | 14 +LOOP 231 | ; 232 | 233 | \ .............................................................................................................. 234 | \ Host configuration .......................................................................................... 235 | 236 | : setMAC ( x0 x1 x2 x3 x4 x5 --) 237 | \ set the host MAC address 238 | hostMAC dup 5 + DO i c! -1 +LOOP 239 | ; 240 | 241 | : setIP ( x0 x1 x2 x3 --) 242 | \ set the host IP address 243 | hostIP dup 3 + DO i c! -1 +LOOP 244 | ; 245 | 246 | : setSubnet ( x0 x1 x2 x3 --) 247 | \ set the host's local network subnet mask 248 | subnet dup 3 + DO i c! -1 +LOOP 249 | ; 250 | 251 | : setRouter ( x0 x1 x2 x3 --) 252 | \ set the host's local network default router 253 | router dup 3 + DO i c! -1 +LOOP 254 | ; 255 | 256 | \ .............................................................................................................. 257 | \ ARP protocol ................................................................................................ 258 | \ Note ARP can be accessed by both the process receiving frames and the process sending frames 259 | \ Therefore always mediate access with ACQUIRE and RELEASE ARPsemaphore 260 | 261 | : Ethernet.dispatchARP ( MAC --) 262 | \ Dispatch the ARP protocol frame to Ethernet address MAC 263 | ARPframe 264 | dup -rot 6 move \ copy in the Ethernet destination MAC address 265 | hostMAC over 6 + 6 move \ copy in the Ethernet source MAC address 266 | dup 12 + 2054 swap w!n \ set EthernetType = 0x0806 267 | 42 \ APR length of 28 plus 14 for Ethernet 268 | ( frame len) putframe 269 | ; 270 | 271 | : ARP.initCache ( --) 272 | \ initialize the ARP cache 273 | ARPcache 112 erase \ zero the cache memory 274 | ticks ( timestamp) 275 | ARPcache dup 112 + swap DO \ timestamp all cache slots with the current time 276 | dup i 10 + ! 277 | 14 +LOOP drop 278 | ; 279 | 280 | : ARP.lookupIP ( IP -- addr flags) 281 | \ lookup IP in cache. Returns flags and addr as follows 282 | \ 0 : IP not found. Address addr can be used to hold this IP entry 283 | \ 1 : partial IP (no MAC) entry available at address addr 284 | \ -1 : complete IP/MAC entry available at address addr 285 | 286 | \ search the ARPchache for this IP address 287 | 0 288 | ARPcache dup 112 + swap DO 289 | over i IP= 290 | IF drop i LEAVE THEN \ IP address found, replace 0 with the pointer to the entry 291 | 14 +LOOP 292 | 293 | \ review the IP chache entry where the IP address was found 294 | nip ( 0 | addr) dup IF \ if IP was found 295 | dup 4 + MACempty MAC= IF \ MAC address is zero 296 | 1 exit \ this is a partial entry 297 | ELSE \ MAC address is not zero 298 | dup 10 + @ ticks swap - \ measure ticks since timestamp 299 | 1200000 > IF \ more than 20 minutes ? 300 | 1 exit \ MAC address is out of date - this is a partial entry 301 | ELSE 302 | -1 exit \ this is a complete entry 303 | THEN 304 | THEN 305 | THEN 306 | drop 307 | 308 | \ IP not found, find the Least Recently Used (LRU) cache entry 309 | ARPcache ticks over 10 + @ over swap - ( oldestEntry ticks oldestAge) \ first entry by default 310 | ARPcache 14 + dup 98 + swap DO \ iterate over entries 1 - 7 311 | i swap >R 10 + @ over swap - ( oldestEntry ticks age R:oldestAge) 312 | R> over over > IF ( oldestEntry ticks age oldestAge) 313 | drop rot drop i -rot ( oldestEntry' ticks oldestAge') \ this entry is older 314 | ELSE 315 | nip 316 | THEN 317 | 14 +LOOP ( oldestEntry ticks oldestAge) 318 | drop drop 0 319 | ; 320 | 321 | : ARP.updateCache ( --) 322 | \ Updates the ARP cache by reference to an ARP reply or request received from the network 323 | \ assumes that inFrame is the incoming ARP frame 324 | inFrame 28 + ARP.lookupIP ( addr flags) \ lookup sender's IP 325 | 0= IF inFrame 28 + over 4 move THEN \ copy sender's IP address if this is a new entry 326 | inFrame 22 + over 4 + 6 move \ copy sender's MAC address 327 | 10 + ticks swap ! \ timestamp the chache entry 328 | ; 329 | 330 | : ARP.request ( IP --) 331 | \ create and send an ARP request WhoIs? IP 332 | ARPframe 333 | ARPheader over 14 + 6 move \ copy in the ARP header 334 | dup 20 + 1 swap w!n \ opcode 1 is an ARP request 335 | hostMAC over 22 + 6 move \ copy in sender's (i.e. host) MAC 336 | hostIP over 28 + 4 move \ copy in sender's IP 337 | dup 32 + 6 erase \ zeros for target MAC 338 | 38 + 4 move \ copy in target IP 339 | MACbroadcast \ destination MAC will be broadcast 340 | ( broadcastMAC) Ethernet.dispatchARP 341 | ; 342 | 343 | : ARP.gratuitous 344 | \ make a gratuitous ARP request for the host's own IP 345 | hostIP ARP.request 346 | ; 347 | 348 | : ARP.reply ( --) 349 | \ create an ARP reply in reponse to a ARP request and dispatch via the Ethernet layer 350 | ARPframe 351 | ARPheader over 14 + 6 move \ copy in the ARP header 352 | dup 20 + 2 swap w!n \ opcode 2 is an ARP reply 353 | hostMAC over 22 + 6 move \ copy in sender's (i.e. host) MAC 354 | hostIP over 28 + 4 move \ copy in sender's IP 355 | InFrame 22 + over 32 + 10 move \ copy the sender fields from the ARP request 356 | \ to the target fields of the ARP reply 357 | 32 + \ destination MAC will be the target MAC 358 | ( targetMAC) Ethernet.dispatchARP 359 | ; 360 | 361 | : ARP.getMAC ( IP -- MAC true | false) 362 | \ obtain the MAC address of an IP address return MAC true if successful, 363 | \ or if a MAC address cannot be obtained make an asynchronous ARP request and exit false 364 | dup ARP.lookupIP -1 = IF \ Only recognize complete entries (i.e. -1, not 1 or 0) 365 | nip 4 + -1 \ reference the MAC address and signal true 366 | ELSE 367 | drop ARP.request 0 \ No MAC address available - do APR request 368 | THEN 369 | ; 370 | 371 | : ARP.in ( --) 372 | \ ARP protocol handles an incoming frame from the network 373 | inFrame 374 | \ ." ARP from" dup 28 + .IP CR \ debug 375 | dup 14 + ARPheader 6 mem= \ confirm the expected ARP header 376 | IF 377 | dup 20 + w@n \ retrieve ARP opcode 378 | CASE 379 | 1 OF \ it is an ARP request 380 | 38 + hostIP IP= IF \ does target IP = host IP ? 381 | ARP.updateCache 382 | ARP.reply 383 | THEN 384 | ENDOF 385 | 2 OF \ it is an ARP reply 386 | 28 + hostIP IP= IF \ does sender IP = host IP ? 387 | ." IP conflict" 388 | ELSE 389 | ARP.updateCache 390 | THEN 391 | ENDOF 392 | ENDCASE 393 | THEN 394 | ; 395 | 396 | \ .............................................................................................................. 397 | \ Frames received from the protocol stack are passed to the network............................................. 398 | 399 | : Ethernet.dispatchIP ( frame MAC --) 400 | \ Dispatch an IP datagram to Ethernet address MAC 401 | swap 402 | hostMAC over 6 + 6 move \ set the source MAC address 403 | 2048 over 12 + w!n \ set the EthernetType = 0x0800 404 | dup -rot 6 move \ set the destination MAC address 405 | dup 16 + w@n 14 + \ retrieve IP length and add 14 for Ethernet 406 | ( frame len) putframe 407 | ; 408 | 409 | : IP.enquireARP ( IP -- MAC true | false) 410 | \ repeatedly try to obtain the MAC address of an IP address by contacting the ARP 411 | \ return MAC true if successful or false if a MAC address cannot be obtained 412 | 2 0 DO \ allow initial cache lookup plus two ARP request attempts 413 | ARPsemaphore ACQUIRE 414 | dup ARP.getMAC ( IP, MAC true | false) \ request ARP for this IP address 415 | ARPsemaphore RELEASE \ important to RELEASE so ARP can handle incoming ARP replies 416 | IF nip -1 UNLOOP EXIT THEN \ MAC found, exit TRUE 417 | i IF 1500 ELSE 500 THEN ms \ allow time for the ARP request (0.5 sec initially, then 1.5 sec) 418 | LOOP 419 | drop 0 \ failed to obtain a MAC address 420 | ; 421 | 422 | : IP.forward ( frame --) 423 | \ Forward an IP frame via direct delivery or indirect delivery 424 | subnet @ ( frame subnet) 425 | over 30 + @ ( frame subnet destIP) 426 | over and >R ( frame subnet R:destNET) 427 | hostIP @ and R> ( frame hostNET destNET) 428 | = IF \ are destination and host on same subnet? 429 | dup 30 + \ direct delivery to the MAC of destination IP 430 | ELSE 431 | router \ indirect delivery to router 432 | THEN 433 | ( frame IP ) IP.enquireARP 434 | ( frame MAC true | false) IF Ethernet.dispatchIP ELSE drop THEN 435 | ; 436 | 437 | : IP.dispatchUDP ( IP --) 438 | \ Prepare an IP frame starting from the UDP frame and then dispatch via IP forwarding 439 | \ The UDP segment of datagram will already have been completed by the caller 440 | UDPframe 441 | 69 over 14 + c! \ version and IHT 442 | 0 over 15 + c! \ DS and ECN 443 | dup 38 + w@n 20 + \ retreive UDP.length and add 20 for IP header 444 | over 16 + w!n \ length 445 | ticks over 18 + w!n \ identification - need to change each packet 446 | 0 over 20 + w! \ flags and fragment offset 447 | 64 over 22 + c! \ time to live 448 | 17 over 23 + c! \ protocol = 17 for UDP 449 | 0 over 24 + w! \ initial value of checksum 450 | hostIP over 26 + 4 move \ copy in source IP address 451 | swap over 30 + 4 move \ copy in destination IP address 452 | dup 14 + 20 checksum over 24 + w! \ compute and save header checksum 453 | ( UDPframe) IP.forward 454 | ; 455 | 456 | \ .............................................................................................................. 457 | \ UDP FORTH terminal ........................................................................................... 458 | 459 | create UDPdestIP 4 allot \ IP address for outgoing UDP frames 460 | variable UDPdestPort \ Destination port of outgoing UDP frames. Word length. MUST USE W@ / W! 461 | variable UDPsrcPort \ Source port of outgoing UDP frames. Word lenght. MUST USE W@ / W! 462 | 463 | : setUDPdestIP ( x0 x1 x2 x3 --) 464 | \ set the host IP address 465 | UDPdestIP dup 3 + DO i c! -1 +LOOP 466 | ; 467 | 468 | : UDP.send ( addr n --) 469 | \ send n characters at address addr by UDP 470 | \ prepare UDP fields 471 | UDPframe ( addr n frame) 472 | UDPsrcPort w@ over 34 + w!n 473 | UDPdestPort w@ over 36 + w!n 474 | over 8 + over 38 + w!n \ add 8 bytes of header to compute UDP size 475 | 0 over 40 + w! \ zero checksum field initially 476 | \ compute checksum starting with the UDP-pseudo header 477 | 0 hostIP 4 checksum-add ( addr n frame sum) 478 | UDPdestIP 4 checksum-add 479 | 17 endian 0= IF 256 * THEN + \ protocol byte 480 | over 38 + w@ + \ UDP length 481 | over 34 + 8 checksum-add \ accumulate true UDP header 482 | ( src n frame sum) 483 | swap >R -rot R@ 42 + swap ( sum src dest n R:frame) 484 | checksum-add&move ( sum R:frame) 485 | checksum-fold ( sum R:frame) 486 | R> 40 + w! \ write the checksum field 487 | UDPdestIP IP.dispatchUDP 488 | ; 489 | 490 | : UDP.checksum ( frame -- checksum) 491 | \ return the checksum of a UDP frame within an IP frame 492 | \ start with the UDP-pseudo header 493 | 0 over 26 + 8 checksum-add \ IP addresses 494 | 17 endian 0= IF 256 * THEN + \ protocol byte 495 | over 38 + w@ + \ UDP length 496 | \ UDP header and frame 497 | over dup 38 + w@n swap 34 + swap ( frame sum addr n) 498 | checksum-add checksum-fold nip 499 | ; 500 | 501 | : UDP.check ( -- destPort) 502 | \ Check an UDP frame. If the checksum is invalid, return 0 503 | \ otherwise return the destination port 504 | inframe 505 | dup UDP.checksum 0= IF 506 | 36 + w@n 507 | ELSE drop 0 THEN 508 | ; 509 | 510 | : UDP.in ( --) 511 | \ Receive a UDP frame from the IP layer 512 | UDP.check ( -- destport | 0) \ validate checksum 513 | 514 | \ ************************************************ 515 | \ adapt code from here for the intended applicaton 516 | ?dup IF 517 | CR ." UDP to port " dup . 518 | UDPsrcPort w@ = IF \ incoming destPort = local scrPort ? 519 | inframe dup 42 + over 38 + w@n 8 - ( frame addr n) 520 | type CR 521 | drop 522 | THEN 523 | THEN 524 | ; 525 | 526 | \ .............................................................................................................. 527 | \ Frames received from the network are passed up the protocol stack............................................. 528 | 529 | : IP.check ( -- protocol) 530 | \ Check an IP frame. If the datagram does not meet assumptions or the destination IP does not match the 531 | \ host IP, return 0. If the datagram is good, return the protocol 532 | inFrame 533 | dup 14 + 20 checksum 0= IF \ confirm checksum = 0 534 | dup 14 + c@ 69 = IF \ confirm version = IPv4 and no optional headers 535 | dup 20 + w@n 8191 and 0= IF \ confirm this is not a fragment 536 | dup 30 + hostIP IP= IF \ confirm destination IP = host IP 537 | 23 + c@ EXIT \ retreive IP protocol 538 | THEN 539 | THEN 540 | THEN 541 | THEN 542 | drop 0 543 | ; 544 | 545 | : IP.in ( --) 546 | \ Receive an IP frame from the Ethernet layer 547 | \ Check the frame and pass it up the protocol stack 548 | IP.check 549 | CASE 550 | 17 OF UDP.in ENDOF \ 0x11 is a UDP datagram 551 | \ expand to handle other protocols 552 | ENDCASE 553 | \ all other datagrams silently dropped 554 | ; 555 | 556 | : Ethernet.check ( -- EthernetType) 557 | \ Check an Ethernet frame. If the frame either does not meet assumptions or if the destination does not match the 558 | \ host MAC / broadcast, return 0. Is the frame is good, return the EthernetType 559 | inframe 560 | dup hostMAC MAC= \ destination MAC = host MAC 561 | over MACbroadcast MAC= or IF \ destination MAC = broadcast 562 | 12 + w@n \ read Ethernet type 563 | ELSE drop 0 THEN 564 | ; 565 | 566 | : Ethernet.in ( --) 567 | \ Receive an IP frame form the MAC controller and pass it up the protocol stack 568 | Ethernet.check ( -- EthernetType) 569 | CASE 570 | 2054 OF \ 0x0806 is an ARP frame 571 | ARPsemaphore ACQUIRE 572 | ARP.in ( --) 573 | ARPsemaphore RELEASE 574 | ENDOF 575 | 2048 OF \ 0x0800 is an IP frame 576 | IP.in ( -- protocol type) 577 | ENDOF 578 | ENDCASE \ all other frames / datagrams are silently discarded 579 | ; 580 | 581 | : EthernetReceiveTask ( --) 582 | \ super-loop running as a separate task that handles incoming frames 583 | ARPsemaphore ACQUIRE 584 | ARP.initcache 585 | ARPsemaphore RELEASE 586 | BEGIN 587 | inframe getFrame 588 | Ethernet.in 589 | AGAIN 590 | ; 591 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Minimal_IP 2 | A minimal UDP/IP stack in FORTH for the N.I.G.E. Machine 3 | 4 | The purpose of this package is to support a UDP/IP terminal on the N.I.G.E. Machine via the Nexys4 / Nexys4DDR Ethernet adapter. However it should be adaptable to other systems. See the comments in `network.f` 5 | 6 | Instructions: copy the files to a microSD card, connect the N.I.G.E. Machine to the network with an Ethernet cable, power on, and at the Forth prompt enter 7 | ```forth 8 | mount 9 | include netnige.f 10 | include network.f 11 | include netcfg1.f 12 | ``` 13 | See the file `netcfg1.f` for how to proceed from here. 14 | 15 | You can also connect two N.I.G.E. Machines together! Do so directly using a crossover Ethernet cable (typically red in colour), or simply by connecting each N.I.G.E. Machine to a router/switch with a standard Ethernet cable. On the second N.I.G.E. Machine use the alternative configuration file: 16 | ```forth 17 | include netcfg2.f 18 | ``` 19 | -------------------------------------------------------------------------------- /TestSim1.F: -------------------------------------------------------------------------------- 1 | \ Simulation test in VXF environment to check an example of 2 | \ 1. ARP frame handling 3 | \ 2. UDP datagram creation 4 | \ 3. ARP cache operation 5 | \ 4. IP forwarding 6 | 7 | decimal 8 | 10 11 12 13 14 15 setMAC 9 | 192 168 1 99 setIP \ 0xC0A80163 10 | 255 255 255 0 setSubnet 11 | 192 168 1 1 setRouter \ 0xC0A80101 12 | 13 | hex 14 | arp.initcache 10 ms \ need to allow ms counter to update - include with VFX forth is too fast! 15 | inframe parseframe ffffffffffff6cf049eef42a080600010800060400016cf049eef42aC0A80101000000000000C0A80163 16 | arp.updatecache 10 ms 17 | inframe parseframe ffffffffffff7df049eef43b080600010800060400017df049eef43bC0A8010a000000000000C0A80163 18 | arp.updatecache .arpcache 10 ms 19 | 20 | c0 a8 01 0a setUDPdestIP 21 | 07 UDPdestPort w! 22 | 05 UDPsrcPort w! 23 | s" my text" udp.send 24 | udpframe .udpfields 25 | -------------------------------------------------------------------------------- /TestSim2.F: -------------------------------------------------------------------------------- 1 | \ Simulation test in VXF environment to check an example of 2 | \ 1. IPchecksum 3 | \ 2. UDPchecksum of an incoming frame 4 | \ 3. UDPchecksum of a synthesized frame 5 | 6 | 7 | decimal 8 | 10 11 12 13 14 15 setMAC 9 | 192 168 1 99 setIP \ 0xC0A80163 10 | 255 255 255 0 setSubnet 11 | 192 168 1 1 setRouter \ 0xC0A80101 12 | HEX 13 | CR 14 | \ 1. IP checksum 15 | UDPframe parseframe 00507f7c9ab06cf049eef42a08004500003c1c46400040060000ac100a63ac100a0c 16 | UDPframe 0E + 14 checksum 17 | CR . ." should be E6B1" \ checksum appears byte reversed on a little endian machine 18 | 19 | \ 2. UDPchecksum of an incoming frame 20 | \ checksum bytes indicated 14de 21 | UDPframe parseframe 00507f7c9ab06cf049eef42a08004500005078910000801100009801331b980e5e4ba08f2694000a14DE626245 22 | UDPframe UDP.checksum 23 | CR . ." should be 0000" 24 | 25 | \ 3. UDPchecksum of a synthesized frame 26 | 98 01 33 1b setIP 27 | 98 0e 5e 4b setUDPdestIP 28 | a08f UDPsrcPort w! 29 | 2694 UDPdestPort w! 30 | inframe parseframe 626245 31 | inframe 2 UDP.send \ suggest edit the last line of UDP.send to omit the actual dispatch 32 | UDPframe 28 + w@n 33 | CR . ." should be 14de" 34 | 35 | \ Some other UDP frames 36 | \ checksum bytes indicated XXXX 37 | UDPframe parseframe 6cf049eef42a00507f7c9ab00800450000500a4400007011f1e83eb74dffc0a8011241cff526003ca0336000000000003b15200100009d3890d7040bbe30c148b200200100009d386ab8283706592df943660104c65626ef040401000000 38 | UDPframe UDP.checksum CR . ." should be 0000" 39 | UDPframe parseframe 6cf049eef42a00507f7c9ab00800450000500a4400007011f1e83eb74dffc0a8011241cff526003c00006000000000003b15200100009d3890d7040bbe30c148b200200100009d386ab8283706592df943660104c65626ef040401000000 40 | UDPframe UDP.checksum CR . ." should be 33A0" 41 | UDPframe parseframe 6cf049eef42a00507f7c9ab0080045000050020200006311aefd5f99854ac0a80112b8bdf526003c6c586000000000003b15200100009d386ab820c74742a0667ab5200100009d386ab8283706592df943660104275b0429040400000000 42 | UDPframe UDP.checksum CR . ." should be 0000" 43 | UDPframe parseframe 6cf049eef42a00507f7c9ab0080045000050020200006311aefd5f99854ac0a80112b8bdf526003c6c586000000000003b15200100009d386ab820c74742a0667ab5200100009d386ab8283706592df943660104275b0429040400000000 44 | UDPframe UDP.checksum CR . ." should be 0000" -------------------------------------------------------------------------------- /VierteDimensionListings/API.f: -------------------------------------------------------------------------------- 1 | \ UDP FORTH terminal ........................................................................................... 2 | 3 | create UDPdestIP 4 allot \ IP address for outgoing UDP frames 4 | variable UDPdestPort \ Destination port of outgoing UDP frames. Word length. MUST USE W@ / W! 5 | variable UDPsrcPort \ Source port of outgoing UDP frames. Word lenght. MUST USE W@ / W! 6 | 7 | : setUDPdestIP ( x0 x1 x2 x3 --) 8 | \ set the host IP address 9 | UDPdestIP dup 3 + DO i c! -1 +LOOP 10 | ; 11 | 12 | : UDP.send ( addr n --) 13 | \ send n characters at address addr by UDP 14 | \ prepare UDP fields 15 | UDPframe ( addr n frame) 16 | UDPsrcPort w@ over 34 + w!n 17 | UDPdestPort w@ over 36 + w!n 18 | over 8 + over 38 + w!n \ add 8 bytes of header to compute UDP size 19 | 0 over 40 + w! \ zero checksum field initially 20 | \ compute checksum starting with the UDP-pseudo header 21 | 0 hostIP 4 checksum-add ( addr n frame sum) 22 | UDPdestIP 4 checksum-add 23 | 17 endian 0= IF 256 * THEN + \ protocol byte 24 | over 38 + w@ + \ UDP length 25 | over 34 + 8 checksum-add \ accumulate true UDP header 26 | ( src n frame sum) 27 | swap >R -rot R@ 42 + swap ( sum src dest n R:frame) 28 | checksum-add&move ( sum R:frame) 29 | checksum-fold ( sum R:frame) 30 | R> 40 + w! \ write the checksum field 31 | UDPdestIP IP.dispatchUDP 32 | ; 33 | 34 | : UDP.in ( --) 35 | \ Receive a UDP frame from the IP layer 36 | UDP.check ( -- destport | 0) \ validate checksum 37 | 38 | \ ************************************************ 39 | \ adapt code from here for the intended applicaton 40 | ?dup IF 41 | CR ." UDP to port " dup . 42 | UDPsrcPort w@ = IF \ incoming destPort = local scrPort ? 43 | inframe dup 42 + over 38 + w@n 8 - ( frame addr n) 44 | type CR 45 | drop 46 | THEN 47 | THEN 48 | ; 49 | 50 | : Ethernet.in ( --) 51 | \ Receive an IP frame form the MAC controller and pass it up the protocol stack 52 | ; 53 | 54 | : EthernetReceiveTask ( --) 55 | \ super-loop running as a separate task that handles incoming frames 56 | ARPsemaphore ACQUIRE 57 | ARP.initcache 58 | ARPsemaphore RELEASE 59 | BEGIN 60 | inframe getFrame 61 | Ethernet.in 62 | AGAIN 63 | ; -------------------------------------------------------------------------------- /VierteDimensionListings/ARP.f: -------------------------------------------------------------------------------- 1 | : ARP.lookupIP ( IP -- addr flags) 2 | \ lookup IP in cache. Returns flags and addr as follows 3 | \ 0 : IP not found. Address addr can be used to hold this IP entry 4 | \ 1 : partial IP (no MAC) entry available at address addr 5 | \ -1 : complete IP/MAC entry available at address addr 6 | ; 7 | 8 | : ARP.request ( IP --) 9 | \ create and send an ARP request WhoIs? IP 10 | ; 11 | 12 | : ARP.getMAC ( IP -- MAC true | false) 13 | \ obtain the MAC address of an IP address return MAC true if successful, 14 | \ or if a MAC address cannot be obtained make an asynchronous ARP request and exit false 15 | dup ARP.lookupIP -1 = IF \ Only recognize complete entries (i.e. -1, not 1 or 0) 16 | nip 4 + -1 \ reference the MAC address and signal true 17 | ELSE 18 | drop ARP.request 0 \ No MAC address available - do APR request 19 | THEN 20 | ; 21 | 22 | : IP.enquireARP ( IP -- MAC true | false) 23 | \ repeatedly try to obtain the MAC address of an IP address by contacting the ARP 24 | \ return MAC true if successful or false if a MAC address cannot be obtained 25 | 2 0 DO \ allow initial cache lookup plus two ARP request attempts 26 | ARPsemaphore ACQUIRE 27 | dup ARP.getMAC ( IP, MAC true | false) \ request ARP for this IP address 28 | ARPsemaphore RELEASE \ important to RELEASE so ARP can handle incoming ARP replies 29 | IF nip -1 UNLOOP EXIT THEN \ MAC found, exit TRUE 30 | i IF 1500 ELSE 500 THEN ms \ allow time for the ARP request (0.5 sec initially, then 1.5 sec) 31 | LOOP 32 | drop 0 \ failed to obtain a MAC address 33 | ; 34 | -------------------------------------------------------------------------------- /VierteDimensionListings/checksum.f: -------------------------------------------------------------------------------- 1 | \ /* Compute Internet Checksum for "count" bytes 2 | \ * beginning at location "addr". 3 | \ */ 4 | \ register long sum = 0; 5 | \ 6 | \ while( count > 1 ) { 7 | \ /* This is the inner loop */ 8 | \ sum += * (unsigned short) addr++; 9 | \ count -= 2; 10 | \ } 11 | \ 12 | \ /* Add left-over byte, if any */ 13 | \ if( count > 0 ) 14 | \ sum += * (unsigned char *) addr; 15 | \ 16 | \ /* Fold 32-bit sum to 16 bits */ 17 | \ while (sum>>16) 18 | \ sum = (sum & 0xffff) + (sum >> 16); 19 | \ 20 | \ checksum = ~sum; 21 | 22 | : checksum-add ( sum addr n -- sum) 23 | \ Sum over 16 bit words in a 32 bit cell and accumulate to sum. 24 | \ Checksum calculations are performed in the natural endian of the machine for speed. 25 | \ Hence need to check machine endian to deal with any odd byte 26 | \ sum over complete words 27 | >R BEGIN ( sum addr R:n) 28 | R@ 1 > 29 | WHILE 30 | dup w@ ( sum addr u) 31 | rot + swap ( sum' addr) 32 | 2 + ( sum' addr') 33 | R> 2 - >R \ decrement n 34 | REPEAT R> ( sum addr 0|1) 35 | \ deal with any left over byte 36 | IF C@ endian IF 256 * THEN + 37 | ELSE drop THEN ( sum) 38 | ; 39 | 40 | : checksum-fold ( sum -- checksum) 41 | \ fold the accumulated carry in a 32 bit-cell back into the 16 bit sum 42 | BEGIN ( sum) 43 | dup 44 | 16 Rshift dup ( sum sum>>16 sum>>16) 45 | WHILE 46 | swap 65535 and ( sum>>16 sumAND0xffff) 47 | + 48 | REPEAT 49 | drop ( sum) 50 | \ invert 16 bit checksum 51 | NOT 65535 and ( x) 52 | \ 0x0000 and 0xffff both stand for 0 in ones's complement: exchange the latter for the former 53 | dup 65535 = IF drop 0 THEN 54 | ; 55 | 56 | : checksum ( addr n -- x) 57 | \ return the internet checksum for n bytes starting at addr 58 | \ routine adapted from https://tools.ietf.org/html/rfc1071 59 | 0 -rot ( 0 addr n) 60 | checksum-add 61 | checksum-fold 62 | ; 63 | 64 | 65 | -------------------------------------------------------------------------------- /VierteDimensionListings/data_structures.f: -------------------------------------------------------------------------------- 1 | decimal 2 | 3 | create inFrame 1518 allot \ An incoming Ethernet frame. 14 + 1500 + 4 bytes maximum 4 | create UDPframe 1518 allot \ An outgoing UDP frame 5 | create ARPframe 1518 allot \ An outgoing ARP frame 6 | 7 | create hostMAC 6 allot \ Host MAC address 8 | create hostIP 4 allot \ Host IP address 9 | create subnet 4 allot \ Host's local network subnet mask 10 | create router 4 allot \ Host's local network router IP 11 | 12 | create MACbroadcast 255 c, 255 c, 255 c, 255 c, 255 c, 255 c, 13 | create MACempty 00 c, 00 c, 00 c, 00 c, 00 c, 00 c, 14 | 15 | \ ARP chache is a simple array with space for 8 entries for 16 | \ IP address (4 bytes), MAC address (6 bytes), timestamp (4 bytes) 17 | create ARPcache 112 allot \ 112 = 14 * 8 -------------------------------------------------------------------------------- /VierteDimensionListings/netNIGE.f: -------------------------------------------------------------------------------- 1 | \ Hardware specific (N.I.G.E. Machine).......................................................................... 2 | hex 3 | 03f860 constant MACreadyRX 4 | 03f864 constant MACdataRX 5 | 03f868 constant MACchecksum_err 6 | 03f86c constant MACreadyTX 7 | 03f870 constant MACdataTX 8 | 03f874 constant MACtransmit_req 9 | decimal 10 | 11 | : getFrame ( frame -- ) 12 | \ wait for an incoming Ethernet frame and place it into inFrame 13 | BEGIN 14 | \ wait for an incoming frame 15 | BEGIN 16 | MACreadyRX @ 17 | pause 18 | UNTIL 19 | \ copy the incoming frame from the FIFO buffer to local storage 20 | dup 1518 + swap DO \ maximum 1518 bytes of data may be copied 21 | MACdataRX @ i c! 22 | MACreadyRX @ 0= IF LEAVE THEN \ ... but exit as soon as the FIFO is empty 23 | LOOP 24 | MACchecksum_err @ not \ confirm checksum validity 25 | UNTIL 26 | ; 27 | 28 | : putFrame ( frame len --) 29 | \ wait until MAC controller is free and then send the Ethernet frame of length len 30 | \ the Ethernet CRC checksum will be computed in hardware by the MAC controller 31 | 32 | \ wait for any existing transmission to complete 33 | BEGIN 34 | MACreadyTX @ 35 | pause 36 | UNTIL 37 | \ transfer the frame to the FIFO buffer 38 | over + swap DO 39 | i C@ MACdataTX C! 40 | LOOP 41 | \ signal the MAC controller to transmit 42 | 0 MACtransmit_req ! 43 | ; 44 | -------------------------------------------------------------------------------- /VierteDimensionListings/stack.f: -------------------------------------------------------------------------------- 1 | : UDP.check ( -- destPort) 2 | \ Check an UDP frame. If the checksum is invalid, return 0 3 | \ otherwise return the destination port 4 | inframe 5 | dup UDP.checksum 0= IF 6 | 36 + w@n 7 | ELSE drop 0 THEN 8 | ; 9 | 10 | : UDP.in ( --) 11 | \ Receive a UDP frame from the IP layer 12 | UDP.check ( -- destport | 0) \ validate checksum 13 | \ further code here to handle the datagram 14 | ; 15 | 16 | : IP.check ( -- protocol) 17 | \ Check an IP frame. If the datagram does not meet assumptions return 0. 18 | \ If the datagram is good, return the protocol 19 | inFrame 20 | dup 14 + 20 checksum 0= IF \ confirm checksum = 0 21 | dup 14 + c@ 69 = IF \ confirm version = IPv4 and no optional headers 22 | dup 20 + w@n 8191 and 0= IF \ confirm this is not a fragment 23 | dup 30 + hostIP IP= IF \ confirm destination IP = host IP 24 | 23 + c@ EXIT \ retreive IP protocol 25 | THEN 26 | THEN 27 | THEN 28 | THEN 29 | drop 0 30 | ; 31 | 32 | : IP.in ( --) 33 | \ Receive an IP frame from the Ethernet layer 34 | \ Check the frame and pass it up the protocol stack 35 | IP.check 36 | CASE 37 | 17 OF UDP.in ENDOF \ 0x11 is a UDP datagram 38 | \ expand to handle other protocols 39 | ENDCASE 40 | \ all other datagrams silently dropped 41 | ; 42 | 43 | : Ethernet.check ( -- EthernetType) 44 | \ Check an Ethernet frame. If the destination does not match the 45 | \ host MAC / broadcast, return 0. Otherwise return the EthernetType 46 | inframe 47 | dup hostMAC MAC= \ destination MAC = host MAC 48 | over MACbroadcast MAC= or IF \ destination MAC = broadcast 49 | 12 + w@n \ read Ethernet type 50 | ELSE drop 0 THEN 51 | ; 52 | 53 | : Ethernet.in ( --) 54 | \ Receive an IP frame form the MAC controller and pass it up the protocol stack 55 | Ethernet.check ( -- EthernetType) 56 | CASE 57 | 2054 OF \ 0x0806 is an ARP frame 58 | ARPsemaphore ACQUIRE 59 | ARP.in ( --) 60 | ARPsemaphore RELEASE 61 | ENDOF 62 | 2048 OF \ 0x0800 is an IP frame 63 | IP.in ( -- protocol type) 64 | ENDOF 65 | ENDCASE \ all other frames / datagrams are silently discarded 66 | ; 67 | 68 | --------------------------------------------------------------------------------