summaryrefslogtreecommitdiff
path: root/lwip/ports/drivers/bbb/locator.c
blob: f8929bbd097fd93c0153936573973003c29baadd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
/*
 * locator.c
 *
 * Device Locator server using UDP
 *
*/
/*
 * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 * 3. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
 * OF SUCH DAMAGE.
 *
 * This file is part of the lwIP TCP/IP stack.
 *
 * Author: Adam Dunkels <adam@sics.se>
 *
*/

/* Copyright (C) 2010 Texas Instruments Incorporated - http://www.ti.com/
 * ALL RIGHTS RESERVED
 */

#include "locator.h"
#include "lwiplib.h"

/******************************************************************************
**                      INTERNAL MACRO DEFINITIONS
*******************************************************************************/
#define TAG_CMD                      (0xff)
#define TAG_STATUS                   (0xfe)
#define CMD_DISCOVER_TARGET          (0x02)

/******************************************************************************
**                    INTERNAL VARIABLE DEFINITIONS
*******************************************************************************/
/*
** An array that contains the device locator response data.  The format of the
** data is as follows:
**
**     Byte        Description
**     --------    ------------------------
**      0          TAG_STATUS
**      1          packet length
**      2          CMD_DISCOVER_TARGET
**      3          board type
**      4          board ID
**      5..8       client IP address
**      9..14      MAC address
**     15..18      firmware version
**     19..82      application title
**     83          checksum
*/
static unsigned char locatorData[84];

/******************************************************************************
**                    INTERNAL FUNCTION PROTOTYPES
*******************************************************************************/
static void LocatorReceive(void *arg, struct udp_pcb *pcb, struct pbuf *p,
                           ip_addr_t *addr, u16_t port);

/******************************************************************************
**                        FUNCTION DEFINITIONS
*******************************************************************************/
/*
** This function is called by the lwIP TCP/IP stack when it receives a UDP
** packet from the discovery port.  It produces the response packet, which is
** sent back to the querying client.
*/
static void LocatorReceive(void *arg, struct udp_pcb *pcb, struct pbuf *p,
                           ip_addr_t *addr, u16_t port)
{
    unsigned char *pucData;
    unsigned long ulIdx;

    /* Validate the contents of the datagram.*/
    pucData = p->payload;
    if((p->len != 4) || (pucData[0] != TAG_CMD) || (pucData[1] != 4) ||
       (pucData[2] != CMD_DISCOVER_TARGET) ||
       (pucData[3] != ((0 - TAG_CMD - 4 - CMD_DISCOVER_TARGET) & 0xff)))
    {
        pbuf_free(p);
        return;
    }

    pbuf_free(p);

    p = pbuf_alloc(PBUF_TRANSPORT, sizeof(locatorData), PBUF_RAM);
    if(p == NULL)
    {
        return;
    }

    /* Calcuate and fill in the checksum on the response packet.*/
    for(ulIdx = 0, locatorData[sizeof(locatorData) - 1] = 0;
        ulIdx < (sizeof(locatorData) - 1); ulIdx++)
    {
        locatorData[sizeof(locatorData) - 1] -=
            locatorData[ulIdx];
    }

    /* Copy the response packet data into the pbuf. */
    pucData = p->payload;
    for(ulIdx = 0; ulIdx < sizeof(locatorData); ulIdx++)
    {
        pucData[ulIdx] = locatorData[ulIdx];
    }

    /* Send the response.*/
    udp_sendto(pcb, p, addr, port);

    pbuf_free(p);
}

/*
** Initializes the locator service. Prepares the locator service to
** handle device discovery requests.  .
*/
void LocatorConfig(unsigned char *macArray, const char *appTitle)
{
    unsigned int idx;
    void *pcb;

    /* Clear out the response data.*/
    for(idx = 0; idx < 84; idx++)
    {
        locatorData[idx] = 0;
    }

    /* Fill in the header for the response data.*/
    locatorData[0] = TAG_STATUS;
    locatorData[1] = sizeof(locatorData);
    locatorData[2] = CMD_DISCOVER_TARGET;

    /* Fill in the MAC address for the response data. */
    locatorData[9] =  macArray[0];
    locatorData[10] = macArray[1];
    locatorData[11] = macArray[2];
    locatorData[12] = macArray[3];
    locatorData[13] = macArray[4];
    locatorData[14] = macArray[5];

    /* Create a new UDP port for listening to device locator requests.*/
    pcb = udp_new();
    udp_recv(pcb, (udp_recv_fn) LocatorReceive, NULL);
    udp_bind(pcb, IP_ADDR_ANY, 23);
    udp_connect(pcb, IP_ADDR_ANY, 23);

    /* Copy the application title string into the response data. */
    for(idx = 0; (idx < 64) && *appTitle; idx++)
    {
        locatorData[idx + 19] = *appTitle++;
    }

    /* Zero-fill the remainder of the space in the response data (if any).*/
    for(; idx < 64; idx++)
    {
        locatorData[idx + 19] = 0;
    }

}
/***************************** End Of File ***********************************/