/**************************************************************************** * wireless/ieee802154/mac802154.c * * Copyright (C) 2016 Sebastien Lorquet. All rights reserved. * Copyright (C) 2017 Gregory Nutt. All rights reserved. * Copyright (C) 2017 Verge Inc. All rights reserved. * * Author: Sebastien Lorquet * Author: Gregory Nutt * Author: Anthony Merlino * * 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. Neither the name NuttX nor the names of its contributors may be * used to endorse or promote products derived from this software * without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS * "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 * COPYRIGHT OWNER OR CONTRIBUTORS 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. * ****************************************************************************/ /**************************************************************************** * Included Files ****************************************************************************/ #include #include #include #include #include #include #include #include #include #include "mac802154.h" #include "mac802154_internal.h" #include "mac802154_assoc.h" #include "mac802154_scan.h" #include "mac802154_data.h" #include "mac802154_poll.h" #include #include /**************************************************************************** * Private Function Prototypes ****************************************************************************/ /* Data structure pools and allocation helpers */ static void mac802154_resetqueues(FAR struct ieee802154_privmac_s *priv); /* IEEE 802.15.4 PHY Interface OPs */ static int mac802154_radiopoll(FAR const struct ieee802154_radiocb_s *radiocb, bool gts, FAR struct ieee802154_txdesc_s **tx_desc); static void mac802154_txdone(FAR const struct ieee802154_radiocb_s *radiocb, FAR struct ieee802154_txdesc_s *tx_desc); static void mac802154_txdone_worker(FAR void *arg); static void mac802154_rxframe(FAR const struct ieee802154_radiocb_s *radiocb, FAR struct ieee802154_data_ind_s *ind); static void mac802154_rxframe_worker(FAR void *arg); static void mac802154_edresult(FAR const struct ieee802154_radiocb_s *radiocb, uint8_t edval); static void mac802154_sfevent(FAR const struct ieee802154_radiocb_s *radiocb, enum ieee802154_sfevent_e sfevent); static void mac802154_purge_worker(FAR void *arg); static void mac802154_rxdatareq(FAR struct ieee802154_privmac_s *priv, FAR struct ieee802154_data_ind_s *ind); static void mac802154_rxdataframe(FAR struct ieee802154_privmac_s *priv, FAR struct ieee802154_data_ind_s *ind); static void mac802154_rxbeaconframe(FAR struct ieee802154_privmac_s *priv, FAR struct ieee802154_data_ind_s *ind); static void mac802154_notify_worker(FAR void *arg); /**************************************************************************** * Private Functions ****************************************************************************/ /**************************************************************************** * Name: mac802154_resetqueues * * Description: * Initializes the various queues used in the MAC layer. Called on creation * of MAC. * ****************************************************************************/ static void mac802154_resetqueues(FAR struct ieee802154_privmac_s *priv) { int i; sq_init(&priv->txdone_queue); sq_init(&priv->csma_queue); sq_init(&priv->gts_queue); sq_init(&priv->indirect_queue); sq_init(&priv->dataind_queue); sq_init(&priv->primitive_queue); /* Initialize the tx descriptor allocation pool */ sq_init(&priv->txdesc_queue); for (i = 0; i < CONFIG_MAC802154_NTXDESC; i++) { sq_addlast((FAR sq_entry_t *)&priv->txdesc_pool[i], &priv->txdesc_queue); } nxsem_init(&priv->txdesc_sem, 0, CONFIG_MAC802154_NTXDESC); } /**************************************************************************** * Name: mac802154_txdesc_pool * * Description: * This function allocates a tx descriptor and the dependent primitive * (data confirmation) from the free list. The primitive and tx descriptor * must be freed separately. * * Assumptions: * priv MAC struct is locked when calling. * * Notes: * If any of the semaphore waits inside this function get interrupted, the * function will release the MAC layer. If this function returns -EINTR, * the calling code should NOT release the MAC semaphore. * ****************************************************************************/ int mac802154_txdesc_alloc(FAR struct ieee802154_privmac_s *priv, FAR struct ieee802154_txdesc_s **txdesc, bool allow_interrupt) { int ret; FAR struct ieee802154_primitive_s *primitive; /* Try and take a count from the semaphore. If this succeeds, we have * "reserved" the structure, but still need to unlink it from the free * list. The MAC is already locked, so there shouldn't be any other * conflicting calls. */ ret = nxsem_trywait(&priv->txdesc_sem); if (ret == OK) { *txdesc = (FAR struct ieee802154_txdesc_s *)sq_remfirst(&priv->txdesc_queue); } else { /* Unlock MAC so that other work can be done to free a notification */ mac802154_unlock(priv) /* Take a count from the tx desc semaphore, waiting if necessary. We * only return from here with an error if we are allowing interruptions * and we received a signal. */ ret = mac802154_takesem(&priv->txdesc_sem, allow_interrupt); if (ret < 0) { /* MAC is already released */ wlwarn("WARNING: mac802154_takesem failed: %d\n", ret); return ret; } /* If we've taken a count from the semaphore, we have "reserved" the * struct but now we need to pop it off of the free list. We need to * re-lock the MAC in order to ensure this happens correctly. */ ret = mac802154_lock(priv, allow_interrupt); if (ret < 0) { wlwarn("WARNING: mac802154_lock failed: %d\n", ret); mac802154_givesem(&priv->txdesc_sem); return ret; } /* We can now safely unlink the next structure from the free list */ *txdesc = (FAR struct ieee802154_txdesc_s *)sq_remfirst(&priv->txdesc_queue); } /* We have now successfully allocated the tx descriptor. Now we need to * allocate the primitive for the data confirmation that gets passed along * with the tx descriptor. These are allocated together, but not freed * together. */ primitive = ieee802154_primitive_allocate(); (*txdesc)->purgetime = 0; (*txdesc)->retrycount = priv->maxretries; (*txdesc)->conf = &primitive->u.dataconf; return OK; } /**************************************************************************** * Name: mac802154_createdatareq * * Description: * Internal function used by various parts of the MAC layer. This function * allocates an IOB, populates the frame according to input args, and * links the IOB into the provided tx descriptor. * * Assumptions: * Called with the MAC locked * ****************************************************************************/ void mac802154_createdatareq(FAR struct ieee802154_privmac_s *priv, FAR struct ieee802154_addr_s *coordaddr, enum ieee802154_addrmode_e srcmode, FAR struct ieee802154_txdesc_s *txdesc) { FAR struct iob_s *iob; /* The only node allowed to use a source address of none is the PAN * Coordinator. PAN coordinators should not be sending data request * commands. */ DEBUGASSERT(srcmode != IEEE802154_ADDRMODE_NONE); /* Allocate an IOB to put the frame in */ iob = iob_alloc(false, IOBUSER_WIRELESS_MAC802154); DEBUGASSERT(iob != NULL); iob->io_flink = NULL; iob->io_len = 0; iob->io_offset = 0; iob->io_pktlen = 0; /* Set the frame control fields */ iob->io_data[0] = 0; iob->io_data[1] = 0; IEEE802154_SETACKREQ(iob->io_data, 0); IEEE802154_SETFTYPE(iob->io_data, 0, IEEE802154_FRAME_COMMAND); IEEE802154_SETDADDRMODE(iob->io_data, 0, coordaddr->mode); IEEE802154_SETSADDRMODE(iob->io_data, 0, srcmode); iob->io_len = 2; /* Each time a data or a MAC command frame is generated, the MAC sublayer * shall copy the value of macDSN into the Sequence Number field of the * MHR of the outgoing frame and then increment it by one. [1] pg. 40. */ iob->io_data[iob->io_len++] = priv->dsn++; /* If the destination address is present, copy the PAN ID and one of the * addresses, depending on mode, into the MHR. */ if (coordaddr->mode != IEEE802154_ADDRMODE_NONE) { mac802154_putpanid(iob, coordaddr->panid); if (coordaddr->mode == IEEE802154_ADDRMODE_SHORT) { mac802154_putsaddr(iob, coordaddr->saddr); } else if (coordaddr->mode == IEEE802154_ADDRMODE_EXTENDED) { mac802154_puteaddr(iob, coordaddr->eaddr); } } /* If the Destination Addressing Mode field is set to indicate that * destination addressing information is not present, the PAN ID * Compression field shall be set to zero and the source PAN identifier * shall contain the value of macPANId. Otherwise, the PAN ID Compression * field shall be set to one. In this case and in accordance with the PAN * ID Compression field, the Destination PAN Identifier field shall * contain the value of macPANId, while the Source PAN Identifier field * shall be omitted. [1] pg. 72 */ if (coordaddr->mode != IEEE802154_ADDRMODE_NONE && IEEE802154_PANIDCMP(coordaddr->panid, priv->addr.panid)) { IEEE802154_SETPANIDCOMP(iob->io_data, 0); } else { mac802154_putpanid(iob, priv->addr.panid); } if (srcmode == IEEE802154_ADDRMODE_SHORT) { mac802154_putsaddr(iob, priv->addr.saddr); } else if (srcmode == IEEE802154_ADDRMODE_EXTENDED) { mac802154_puteaddr(iob, priv->addr.eaddr); } /* Copy in the Command Frame Identifier */ iob->io_data[iob->io_len++] = IEEE802154_CMD_DATA_REQ; /* Copy the IOB reference to the descriptor */ txdesc->frame = iob; txdesc->frametype = IEEE802154_FRAME_COMMAND; txdesc->ackreq = true; /* Save a copy of the destination addressing information into the tx * descriptor. We only do this for commands to help with handling their * progession. */ memcpy(&txdesc->destaddr, &coordaddr, sizeof(struct ieee802154_addr_s)); /* Save a reference of the tx descriptor */ priv->cmd_desc = txdesc; } /**************************************************************************** * Name: mac802154_notify * * Description: * Queue the primitive in the queue and queue work on the LPWORK * queue if is not already scheduled. * * Assumptions: * Called with the MAC locked * ****************************************************************************/ void mac802154_notify(FAR struct ieee802154_privmac_s *priv, FAR struct ieee802154_primitive_s *primitive) { sq_addlast((FAR sq_entry_t *)primitive, &priv->primitive_queue); if (work_available(&priv->notifwork)) { work_queue(LPWORK, &priv->notifwork, mac802154_notify_worker, (FAR void *)priv, 0); } } /**************************************************************************** * Name: mac802154_notify_worker * * Description: * Pop each primitive off the queue and call the registered * callbacks. There is special logic for handling ieee802154_data_ind_s. * ****************************************************************************/ static void mac802154_notify_worker(FAR void *arg) { FAR struct ieee802154_privmac_s *priv = (FAR struct ieee802154_privmac_s *)arg; FAR struct mac802154_maccb_s *cb; FAR struct ieee802154_primitive_s *primitive; int ret; mac802154_lock(priv, false); primitive = (FAR struct ieee802154_primitive_s *)sq_remfirst(&priv->primitive_queue); mac802154_unlock(priv); while (primitive != NULL) { /* Data indications are a special case since the frame can only be * passed to one place. The return value of the notify call is used to * accept or reject the primitive. In the case of the data indication, * there can only be one accept. Callbacks are stored in order of * there receiver priority ordered when the callbacks are bound in * mac802154_bind(). */ if (primitive->type == IEEE802154_PRIMITIVE_IND_DATA) { bool dispose = true; primitive->nclients = 1; for (cb = priv->cb; cb != NULL; cb = cb->flink) { if (cb->notify != NULL) { ret = cb->notify(cb, primitive); if (ret >= 0) { /* The receiver accepted and disposed of the frame and * it's meta-data. We are done. */ dispose = false; break; } } } if (dispose) { iob_free(primitive->u.dataind.frame, IOBUSER_WIRELESS_MAC802154); ieee802154_primitive_free(primitive); } } else { /* Set the number of clients count so that the primitive resources * will be preserved until all clients are finished with it. */ primitive->nclients = priv->nclients; /* Try to notify every registered MAC client */ for (cb = priv->cb; cb != NULL; cb = cb->flink) { if (cb->notify != NULL) { ret = cb->notify(cb, primitive); if (ret < 0) { ieee802154_primitive_free(primitive); } } else { ieee802154_primitive_free(primitive); } } } /* Get the next primitive then loop */ mac802154_lock(priv, false); primitive = (FAR struct ieee802154_primitive_s *) sq_remfirst(&priv->primitive_queue); mac802154_unlock(priv); } } /**************************************************************************** * Name: mac802154_updatebeacon * * Description: * This function is called in the following scenarios: * - The MAC receives a START.request primitive * - Upon receiving the IEEE802154_SFEVENT_ENDOFACTIVE event from the * this radio layer, the MAC checks the bf_update flag and if set * calls function. The bf_update flag is set when various attributes * that effect the beacon are updated. * * Internal function used by various parts of the MAC layer. This function * uses the various MAC attributes to update the beacon frame. It loads * the inactive beacon frame structure and then notifies the radio layer * new frame. the provided tx descriptor in the indirect list and manages * of the the scheduling for purging the transaction if it does not get * extracted in time. * * Assumptions: * Called with the MAC locked * ****************************************************************************/ void mac802154_updatebeacon(FAR struct ieee802154_privmac_s *priv) { FAR struct ieee802154_txdesc_s *txdesc; FAR struct ieee802154_beaconframe_s *beacon; uint8_t pendaddrspec_ind; uint8_t pendeaddr = 0; uint8_t pendsaddr = 0; /* Switch the buffer */ priv->bf_ind = !priv->bf_ind; /* Get a local reference to the beacon frame */ beacon = &priv->beaconframe[priv->bf_ind]; /* Clear the frame control fields */ beacon->bf_data[0] = 0; beacon->bf_data[1] = 0; beacon->bf_len = 2; IEEE802154_SETFTYPE(beacon->bf_data, 0, IEEE802154_FRAME_BEACON); /* Check if there is a broadcast message pending, if there is, we must set * the frame pending bit to 1. */ /* TODO: handle broadcast frame */ DEBUGASSERT(priv->addr.mode != IEEE802154_ADDRMODE_NONE); IEEE802154_SETDADDRMODE(beacon->bf_data, 0, IEEE802154_ADDRMODE_NONE); IEEE802154_SETSADDRMODE(beacon->bf_data, 0, priv->addr.mode); IEEE802154_SETVERSION(beacon->bf_data, 0, 1); /* The beacon sequence number has to be taken care of by the radio layer, * since we only want to update the whole frame when more changes than * just the bsn. */ beacon->bf_len++; IEEE802154_PANIDCOPY(&beacon->bf_data[beacon->bf_len], priv->addr.panid); beacon->bf_len += IEEE802154_PANIDSIZE; if (priv->addr.mode == IEEE802154_ADDRMODE_SHORT) { IEEE802154_SADDRCOPY(&beacon->bf_data[beacon->bf_len], priv->addr.saddr); beacon->bf_len += IEEE802154_SADDRSIZE; } else { IEEE802154_EADDRCOPY(&beacon->bf_data[beacon->bf_len], priv->addr.eaddr); beacon->bf_len += IEEE802154_EADDRSIZE; } /* Clear the superframe specification, then set the appropriate bits */ beacon->bf_data[beacon->bf_len] = 0; beacon->bf_data[beacon->bf_len + 1] = 0; IEEE802154_SETBEACONORDER(beacon->bf_data, beacon->bf_len, priv->sfspec.beaconorder); IEEE802154_SETSFORDER(beacon->bf_data, beacon->bf_len, priv->sfspec.sforder); IEEE802154_SETFINCAPSLOT(beacon->bf_data, beacon->bf_len, priv->sfspec.final_capslot); if (priv->sfspec.ble) { IEEE802154_SETBLE(beacon->bf_data, beacon->bf_len); } if (priv->sfspec.pancoord) { IEEE802154_SETPANCOORD(beacon->bf_data, beacon->bf_len); } if (priv->sfspec.assocpermit) { IEEE802154_SETASSOCPERMIT(beacon->bf_data, beacon->bf_len); } beacon->bf_len += 2; /* TODO: Handle GTS properly, for now, we just set the descriptor count to * zero and specify that we do not permit GTS requests. */ beacon->bf_data[beacon->bf_len++] = 0; /* TODO: Add GTS List here */ /* Skip the pending address specification field for now */ pendaddrspec_ind = beacon->bf_len++; txdesc = (FAR struct ieee802154_txdesc_s *) sq_peek(&priv->indirect_queue); while (txdesc != NULL) { if (txdesc->destaddr.mode == IEEE802154_ADDRMODE_SHORT) { pendsaddr++; IEEE802154_SADDRCOPY(&beacon->bf_data[beacon->bf_len], txdesc->destaddr.saddr); beacon->bf_len += IEEE802154_SADDRSIZE; } else if (txdesc->destaddr.mode == IEEE802154_ADDRMODE_EXTENDED) { pendeaddr++; IEEE802154_EADDRCOPY(&beacon->bf_data[beacon->bf_len], txdesc->destaddr.eaddr); beacon->bf_len += IEEE802154_EADDRSIZE; } /* Check if we are up to 7 addresses yet */ if ((pendsaddr + pendeaddr) == 7) { break; } /* Get the next pending indirect transaction */ txdesc = (FAR struct ieee802154_txdesc_s *) sq_next((FAR sq_entry_t *)txdesc); } /* At this point, we know how many of each transaction we have, we can * setup the Pending Address Specification field */ beacon->bf_data[pendaddrspec_ind] = (pendsaddr & 0x07) | ((pendeaddr << 4) & 0x70); /* Copy in the beacon payload */ memcpy(&beacon->bf_data[beacon->bf_len], priv->beaconpayload, priv->beaconpayloadlength); beacon->bf_len += priv->beaconpayloadlength; priv->beaconupdate = false; } /**************************************************************************** * Name: mac802154_setupindirect * * Description: * Internal function used by various parts of the MAC layer. This function * places the provided tx descriptor in the indirect list and manages the * scheduling for purging the transaction if it does not get extracted in * time. * * Assumptions: * Called with the MAC locked * ****************************************************************************/ void mac802154_setupindirect(FAR struct ieee802154_privmac_s *priv, FAR struct ieee802154_txdesc_s *txdesc) { uint32_t ticks; uint32_t symbols; /* Link the tx descriptor into the list */ sq_addlast((FAR sq_entry_t *)txdesc, &priv->indirect_queue); /* Update the timestamp for purging the transaction */ /* The maximum time (in unit periods) that a transaction is stored by a * coordinator and indicated in its beacon. The unit period is governed * by macBeaconOrder, BO, as follows: For 0 ≤ BO ≤ 14, the unit period * will be aBaseSuperframeDuration × 2 BO . For BO = 15, the unit period * will be aBaseSuperframeDuration. [1] pg. 129 */ if (priv->sfspec.beaconorder < 15) { symbols = priv->trans_persisttime * (IEEE802154_BASE_SUPERFRAME_DURATION * (1 << priv->sfspec.beaconorder)); } else { symbols = priv->trans_persisttime * IEEE802154_BASE_SUPERFRAME_DURATION; } ticks = mac802154_symtoticks(priv, symbols); txdesc->purgetime = clock_systime_ticks() + ticks; /* Make sure the beacon gets updated */ if (priv->sfspec.beaconorder < 15) { priv->beaconupdate = true; } /* Check to see if the purge indirect timer is scheduled. If it is, when * the timer fires, it will schedule the next purge timer event. * Inherently, the queue will be in order of which transaction needs to * be purged next. * * If the purge indirect timer has not been scheduled, schedule it for when * this transaction should expire. */ if (work_available(&priv->purge_work)) { work_queue(HPWORK, &priv->purge_work, mac802154_purge_worker, (FAR void *)priv, ticks); } } /**************************************************************************** * Name: mac802154_purge_worker * * Description: * Worker function scheduled in order to purge expired indirect * transactions. The first element in the list should always be removed. * The list is searched and transactions are removed until a transaction * has not yet expired. Then if there are any remaining transactions, the * work function is rescheduled for the next expiring transaction. * ****************************************************************************/ static void mac802154_purge_worker(FAR void *arg) { FAR struct ieee802154_privmac_s *priv = (FAR struct ieee802154_privmac_s *)arg; FAR struct ieee802154_txdesc_s *txdesc; /* Get exclusive access to the driver structure. We don't care about any * signals so don't allow interruptions */ mac802154_lock(priv, false); while (1) { /* Pop transactions off indirect queue until the transaction timeout * has not passed. */ txdesc = (FAR struct ieee802154_txdesc_s *) sq_peek(&priv->indirect_queue); if (txdesc == NULL) { break; } /* Should probably check a little ahead and remove the transaction if * it is within a certain number of clock ticks away. There is no * since in scheduling the timer to expire in only a few ticks. */ if (clock_systime_ticks() >= txdesc->purgetime) { /* Unlink the transaction */ sq_remfirst(&priv->indirect_queue); /* Free the IOB, the notification, and the tx descriptor */ iob_free(txdesc->frame, IOBUSER_WIRELESS_MAC802154); ieee802154_primitive_free((FAR struct ieee802154_primitive_s *) txdesc->conf); mac802154_txdesc_free(priv, txdesc); priv->beaconupdate = true; wlinfo("Indirect TX purged"); } else { /* Reschedule the transaction for the next timeout */ work_queue(HPWORK, &priv->purge_work, mac802154_purge_worker, priv, txdesc->purgetime - clock_systime_ticks()); break; } } mac802154_unlock(priv); } /**************************************************************************** * Name: mac802154_radiopoll * * Description: * Called from the radio driver through the callback struct. This * function is called when the radio has room for another transaction. If * the MAC layer has a transaction, it copies it into the supplied buffer * and returns the length. A descriptor is also populated with the * transaction. * ****************************************************************************/ static int mac802154_radiopoll(FAR const struct ieee802154_radiocb_s *radiocb, bool gts, FAR struct ieee802154_txdesc_s **txdesc) { FAR struct mac802154_radiocb_s *cb = (FAR struct mac802154_radiocb_s *)radiocb; FAR struct ieee802154_privmac_s *priv; DEBUGASSERT(cb != NULL && cb->priv != NULL); priv = cb->priv; /* Get exclusive access to the driver structure. Ignore EINTR signals */ mac802154_lock(priv, false); if (gts) { /* Check to see if there are any GTS transactions waiting */ *txdesc = (FAR struct ieee802154_txdesc_s *) sq_remfirst(&priv->gts_queue); } else { /* Check to see if there are any CSMA transactions waiting */ *txdesc = (FAR struct ieee802154_txdesc_s *) sq_remfirst(&priv->csma_queue); } mac802154_unlock(priv) if (*txdesc != NULL) { return (*txdesc)->frame->io_len; } return 0; } /**************************************************************************** * Name: mac802154_txdone * * Description: * Called from the radio driver through the callback struct. This * function is called when the radio has completed a transaction. The * txdesc passed gives provides information about the completed * transaction including the original handle provided when the transaction * was created and the status of the transaction. This function copies * the descriptor and schedules work to handle the transaction without * blocking the radio. * ****************************************************************************/ static void mac802154_txdone(FAR const struct ieee802154_radiocb_s *radiocb, FAR struct ieee802154_txdesc_s *txdesc) { FAR struct mac802154_radiocb_s *cb = (FAR struct mac802154_radiocb_s *)radiocb; FAR struct ieee802154_privmac_s *priv; DEBUGASSERT(cb != NULL && cb->priv != NULL); priv = cb->priv; /* Get exclusive access to the driver structure. We don't care about any * signals so don't allow interruptions */ mac802154_lock(priv, false); sq_addlast((FAR sq_entry_t *)txdesc, &priv->txdone_queue); mac802154_unlock(priv) /* Schedule work with the work queue to process the completion further */ if (work_available(&priv->txdone_work)) { work_queue(HPWORK, &priv->txdone_work, mac802154_txdone_worker, (FAR void *)priv, 0); } } /**************************************************************************** * Name: mac802154_txdone_worker * * Description: * Worker function scheduled from mac802154_txdone. This function pops any * TX descriptors off of the list and calls the next highest layer callback * to inform the layer of the completed transaction and the status of it. * ****************************************************************************/ static void mac802154_txdone_worker(FAR void *arg) { FAR struct ieee802154_privmac_s *priv = (FAR struct ieee802154_privmac_s *)arg; FAR struct ieee802154_txdesc_s *txdesc; FAR struct ieee802154_primitive_s *primitive; /* Get exclusive access to the driver structure. We don't care about any * signals so don't allow interruptions */ mac802154_lock(priv, false); while (1) { txdesc = (FAR struct ieee802154_txdesc_s *) sq_remfirst(&priv->txdone_queue); if (txdesc == NULL) { break; } /* Cast the data_conf to a notification. We get both the private and * public notification structure to make it easier to use. */ primitive = (FAR struct ieee802154_primitive_s *)txdesc->conf; wlinfo("Tx status: %s\n", IEEE802154_STATUS_STRING[txdesc->conf->status]); switch (txdesc->frametype) { case IEEE802154_FRAME_DATA: { primitive->type = IEEE802154_PRIMITIVE_CONF_DATA; mac802154_notify(priv, primitive); } break; case IEEE802154_FRAME_COMMAND: { switch (priv->curr_cmd) { case IEEE802154_CMD_ASSOC_REQ: mac802154_txdone_assocreq(priv, txdesc); break; case IEEE802154_CMD_ASSOC_RESP: break; case IEEE802154_CMD_DISASSOC_NOT: break; case IEEE802154_CMD_DATA_REQ: /* Data requests can be sent for 3 different reasons. * * 1. On a beacon-enabled PAN, this command shall be sent * by a device when macAutoRequest is equal to TRUE * and a beacon frame indicating that data are pending * for that device is received from its coordinator. * 2. when instructed to do so by the next higher layer * on reception of the MLME-POLL.request primitive. * 3. a device may send this command to the coordinator * macResponseWaitTime after the acknowledgment to an * association request command. */ switch (priv->curr_op) { case MAC802154_OP_ASSOC: mac802154_txdone_datareq_assoc(priv, txdesc); break; case MAC802154_OP_POLL: mac802154_txdone_datareq_poll(priv, txdesc); break; default: break; } break; case IEEE802154_CMD_PANID_CONF_NOT: break; case IEEE802154_CMD_ORPHAN_NOT: break; case IEEE802154_CMD_BEACON_REQ: break; case IEEE802154_CMD_COORD_REALIGN: break; case IEEE802154_CMD_GTS_REQ: break; default: ieee802154_primitive_free(primitive); break; } } break; default: { ieee802154_primitive_free(primitive); } break; } /* Free the IOB and the tx descriptor */ iob_free(txdesc->frame, IOBUSER_WIRELESS_MAC802154); mac802154_txdesc_free(priv, txdesc); } mac802154_unlock(priv) } /**************************************************************************** * Name: mac802154_rxframe * * Description: * Called from the radio driver through the callback struct. This * function is called when the radio has received a frame. The frame is * passed in an iob, so that we can free it when we are done processing. * A pointer to the RX descriptor is passed along with the iob, but it * must be copied here as it is allocated directly on the caller's stack. * We simply link the frame, copy the RX descriptor, and schedule a worker * to process the frame later so that we do not hold up the radio. * ****************************************************************************/ static void mac802154_rxframe(FAR const struct ieee802154_radiocb_s *radiocb, FAR struct ieee802154_data_ind_s *ind) { FAR struct mac802154_radiocb_s *cb = (FAR struct mac802154_radiocb_s *)radiocb; FAR struct ieee802154_privmac_s *priv; DEBUGASSERT(cb != NULL && cb->priv != NULL); priv = cb->priv; /* Get exclusive access to the driver structure. We don't care about any * signals so if we see one, just go back to trying to get access again. */ mac802154_lock(priv, false); /* Push the iob onto the tail of the frame list for processing */ sq_addlast((FAR sq_entry_t *)ind, &priv->dataind_queue); wlinfo("Frame received\n"); mac802154_unlock(priv) /* Schedule work with the work queue to process the completion further */ if (work_available(&priv->rx_work)) { work_queue(HPWORK, &priv->rx_work, mac802154_rxframe_worker, (FAR void *)priv, 0); } } /**************************************************************************** * Name: mac802154_rxframe_worker * * Description: * Worker function scheduled from mac802154_rxframe. This function * processes any frames in the list. Frames intended to be consumed by * the MAC layer will not produce any callbacks to the next highest layer. * Frames intended for the application layer will be forwarded to them. * ****************************************************************************/ static void mac802154_rxframe_worker(FAR void *arg) { FAR struct ieee802154_privmac_s *priv = (FAR struct ieee802154_privmac_s *)arg; FAR struct ieee802154_data_ind_s *ind; FAR struct iob_s *iob; uint16_t *frame_ctrl; bool panid_comp; uint8_t ftype; while (1) { /* Get exclusive access to the driver structure. We don't care about * any signals so if we see one, just go back to trying to get access * again. */ mac802154_lock(priv, false); /* Pop the data indication from the head of the frame list for * processing. Note: dataind_queue contains ieee802154_primitive_s * which is safe to cast directly to a data indication. */ ind = (FAR struct ieee802154_data_ind_s *) sq_remfirst(&priv->dataind_queue); /* Once we pop off the indication, we needn't to keep the mac locked */ mac802154_unlock(priv) if (ind == NULL) { return; } /* Get a local copy of the frame to make it easier to access */ iob = ind->frame; /* Set a local pointer to the frame control then move the offset past * the frame control field */ frame_ctrl = (uint16_t *)&iob->io_data[iob->io_offset]; iob->io_offset += 2; /* We use the data_ind_s as a container for the frame information even * if this isn't a data frame */ ind->src.mode = (*frame_ctrl & IEEE802154_FRAMECTRL_SADDR) >> IEEE802154_FRAMECTRL_SHIFT_SADDR; ind->dest.mode = (*frame_ctrl & IEEE802154_FRAMECTRL_DADDR) >> IEEE802154_FRAMECTRL_SHIFT_DADDR; panid_comp = (*frame_ctrl & IEEE802154_FRAMECTRL_PANIDCOMP) >> IEEE802154_FRAMECTRL_SHIFT_PANIDCOMP; ind->dsn = iob->io_data[iob->io_offset++]; /* If the destination address is included */ if (ind->dest.mode != IEEE802154_ADDRMODE_NONE) { /* Get the destination PAN ID */ mac802154_takepanid(iob, ind->dest.panid); if (ind->dest.mode == IEEE802154_ADDRMODE_SHORT) { mac802154_takesaddr(iob, ind->dest.saddr); } else if (ind->dest.mode == IEEE802154_ADDRMODE_EXTENDED) { mac802154_takeeaddr(iob, ind->dest.eaddr); } } if (ind->src.mode != IEEE802154_ADDRMODE_NONE) { /* If the source address is included, and the PAN ID compression * field is set, get the PAN ID from the header. */ if (panid_comp) { /* The source PAN ID is equal to the destination PAN ID */ IEEE802154_PANIDCOPY(ind->src.panid, ind->dest.panid); } else { mac802154_takepanid(iob, ind->src.panid); } if (ind->src.mode == IEEE802154_ADDRMODE_SHORT) { mac802154_takesaddr(iob, ind->src.saddr); } else if (ind->src.mode == IEEE802154_ADDRMODE_EXTENDED) { mac802154_takeeaddr(iob, ind->src.eaddr); } } /* If the MAC is in promiscuous mode, just pass everything to the next * layer assuming it is data */ if (priv->promisc) { mac802154_notify(priv, (FAR struct ieee802154_primitive_s *)ind); continue; } ftype = (*frame_ctrl & IEEE802154_FRAMECTRL_FTYPE) >> IEEE802154_FRAMECTRL_SHIFT_FTYPE; switch (ftype) { case IEEE802154_FRAME_DATA: { mac802154_rxdataframe(priv, ind); } break; case IEEE802154_FRAME_COMMAND: { /* Get the command type. The command type is always the first * field after the MHR. Consu;me the byte by increasing offset * so that subsequent functions can start from the byte after * the command ID. */ uint8_t cmdtype = iob->io_data[iob->io_offset++]; switch (cmdtype) { case IEEE802154_CMD_ASSOC_REQ: wlinfo("Assoc request received\n"); mac802154_rx_assocreq(priv, ind); break; case IEEE802154_CMD_ASSOC_RESP: wlinfo("Assoc response received\n"); mac802154_rx_assocresp(priv, ind); break; case IEEE802154_CMD_DISASSOC_NOT: wlinfo("Disassoc primitive received\n"); break; case IEEE802154_CMD_DATA_REQ: wlinfo("Data request received\n"); mac802154_rxdatareq(priv, ind); break; case IEEE802154_CMD_PANID_CONF_NOT: wlinfo("PAN ID Conflict primitive received\n"); break; case IEEE802154_CMD_ORPHAN_NOT: wlinfo("Orphan primitive received\n"); break; case IEEE802154_CMD_BEACON_REQ: wlinfo("Beacon request received\n"); break; case IEEE802154_CMD_COORD_REALIGN: wlinfo("Coord realign received\n"); break; case IEEE802154_CMD_GTS_REQ: wlinfo("GTS request received\n"); break; } /* Free the data indication struct from the pool */ ieee802154_primitive_free((FAR struct ieee802154_primitive_s *) ind); } break; case IEEE802154_FRAME_BEACON: { wlinfo("Beacon frame received. BSN: 0x%02X\n", ind->dsn); mac802154_rxbeaconframe(priv, ind); ieee802154_primitive_free((FAR struct ieee802154_primitive_s *) ind); } break; case IEEE802154_FRAME_ACK: { /* The radio layer is responsible for handling all ACKs and * retries. If for some reason an ACK gets here, just throw * it out. */ wlinfo("ACK received\n"); ieee802154_primitive_free((FAR struct ieee802154_primitive_s *) ind); } break; } } } /**************************************************************************** * Name: mac802154_rxdataframe * * Description: * Function called from the generic RX Frame worker to parse and handle the * reception of a data frame. * ****************************************************************************/ static void mac802154_rxdataframe(FAR struct ieee802154_privmac_s *priv, FAR struct ieee802154_data_ind_s *ind) { FAR struct ieee802154_primitive_s *primitive; /* Get exclusive access to the MAC */ mac802154_lock(priv, false); /* If we are currently performing a POLL operation and we've * received a data response, use the addressing information * to determine if it is extracted data. If the addressing info * matches, notify the next highest layer using POLL.confirm * primitive. If the addressing information does not match, * handle the transaction like any other data transaction. * * Note: We can't receive frames without addressing information * unless we are the PAN coordinator. And in that situation, we * wouldn't be performing a POLL operation. Meaning: * * If the current operation is POLL, we aren't the PAN coordinator * so the incoming frame CAN'T * * FIXME: Fix documentation */ if (priv->curr_op == MAC802154_OP_POLL || priv->curr_op == MAC802154_OP_ASSOC || priv->curr_op == MAC802154_OP_AUTOEXTRACT) { /* If we are in promiscuous mode, we need to check if the * frame is even for us first. If the address is not ours, * then handle the frame like a normal transaction. */ if (priv->promisc) { if (!IEEE802154_PANIDCMP(ind->dest.panid, priv->addr.panid)) { mac802154_notify(priv, (FAR struct ieee802154_primitive_s *) ind); } if (ind->dest.mode == IEEE802154_ADDRMODE_SHORT && !IEEE802154_SADDRCMP(ind->dest.saddr, priv->addr.saddr)) { mac802154_notify(priv, (FAR struct ieee802154_primitive_s *) ind); } else if (ind->dest.mode == IEEE802154_ADDRMODE_EXTENDED && !IEEE802154_EADDRCMP(ind->dest.eaddr, priv->addr.eaddr)) { mac802154_notify(priv, (FAR struct ieee802154_primitive_s *) ind); } else { mac802154_notify(priv, (FAR struct ieee802154_primitive_s *) ind); } } /* If this was our extracted data, the source addressing field can only * be NONE if we are trying to extract data from the PAN coordinator. * A PAN coordinator shouldn't be sending us a frame if it wasn't * our extracted data. Therefore just assume if the address mode is set * to NONE, we process it as our extracted frame */ if (ind->src.mode != priv->cmd_desc->destaddr.mode) { mac802154_notify(priv, (FAR struct ieee802154_primitive_s *) ind); } if (ind->src.mode == IEEE802154_ADDRMODE_SHORT && !IEEE802154_SADDRCMP(ind->src.saddr, priv->cmd_desc->destaddr.saddr)) { mac802154_notify(priv, (FAR struct ieee802154_primitive_s *) ind); } else if (ind->src.mode == IEEE802154_ADDRMODE_EXTENDED && !IEEE802154_EADDRCMP(ind->src.eaddr, priv->cmd_desc->destaddr.eaddr)) { mac802154_notify(priv, (FAR struct ieee802154_primitive_s *) ind); } /* If we've gotten this far, the frame is our extracted data. Cancel * the timeout */ mac802154_timercancel(priv); /* If a frame is received from the coordinator with a zero length * payload or if the frame is a MAC command frame, the MLME will issue * the MLME-POLL.confirm primitive with a status of NO_DATA. [1] pg. * 111 */ primitive = ieee802154_primitive_allocate(); if (priv->curr_op == MAC802154_OP_POLL) { primitive->type = IEEE802154_PRIMITIVE_CONF_POLL; if (ind->frame->io_offset == ind->frame->io_len) { primitive->u.pollconf.status = IEEE802154_STATUS_NO_DATA; } else { primitive->u.pollconf.status = IEEE802154_STATUS_SUCCESS; } } else if (priv->curr_op == MAC802154_OP_ASSOC) { /* If we ever receive a data frame back as a response to the * association request, we assume it means there wasn't any data. */ primitive->type = IEEE802154_PRIMITIVE_CONF_ASSOC; primitive->u.assocconf.status = IEEE802154_STATUS_NO_DATA; } /* We are no longer performing the association operation */ priv->curr_op = MAC802154_OP_NONE; priv->cmd_desc = NULL; mac802154_givesem(&priv->opsem); /* Release the MAC and notify the next highest layer */ mac802154_notify(priv, primitive); /* If there was data, pass it along */ if (ind->frame->io_len > ind->frame->io_offset) { mac802154_notify(priv, (FAR struct ieee802154_primitive_s *)ind); } else { ieee802154_primitive_free( (FAR struct ieee802154_primitive_s *)ind); } } else { mac802154_notify(priv, (FAR struct ieee802154_primitive_s *)ind); } mac802154_unlock(priv) } /**************************************************************************** * Name: mac802154_rxdatareq * * Description: * Function called from the generic RX Frame worker to parse and handle the * reception of an Data Request MAC command frame. * ****************************************************************************/ static void mac802154_rxdatareq(FAR struct ieee802154_privmac_s *priv, FAR struct ieee802154_data_ind_s *ind) { FAR struct ieee802154_txdesc_s *txdesc; FAR struct iob_s *iob; uint16_t *frame_ctrl; /* Get exclusive access to the MAC */ mac802154_lock(priv, false); /* Search the list of indirect transactions to see if there are any waiting * for the requesting device. */ /* TODO: I believe there is an issue here. If there is for some reason a * outgoing data frame to a device who is currently requesting association, * we will send the data frame as a response to an association request. We * need to check for this condition. */ txdesc = (FAR struct ieee802154_txdesc_s *)sq_peek(&priv->indirect_queue); while (txdesc != NULL) { if (txdesc->destaddr.mode == ind->src.mode) { if (txdesc->destaddr.mode == IEEE802154_ADDRMODE_SHORT) { if (IEEE802154_SADDRCMP(txdesc->destaddr.saddr, ind->src.saddr)) { /* Remove the transaction from the queue */ sq_rem((FAR sq_entry_t *)txdesc, &priv->indirect_queue); /* NOTE: We don't do anything with the purge timeout, * because we really don't need to. As of now, I see no * disadvantage to just letting the timeout expire, which * won't purge the transaction since it is no longer on * the list, and then it will reschedule the next timeout * appropriately. The logic otherwise may get complicated * even though it may save a few clock cycles. */ /* The addresses match, send the transaction immediately */ priv->radio->txdelayed(priv->radio, txdesc, 0); priv->beaconupdate = true; mac802154_unlock(priv) return; } } else if (txdesc->destaddr.mode == IEEE802154_ADDRMODE_EXTENDED) { if (IEEE802154_EADDRCMP(txdesc->destaddr.eaddr, ind->src.eaddr)) { /* Remove the transaction from the queue */ sq_rem((FAR sq_entry_t *)txdesc, &priv->indirect_queue); /* The addresses match, send the transaction immediately */ priv->radio->txdelayed(priv->radio, txdesc, 0); priv->beaconupdate = true; mac802154_unlock(priv) return; } } else { DEBUGASSERT(false); } } txdesc = (FAR struct ieee802154_txdesc_s *) sq_next((FAR sq_entry_t *)txdesc); } /* If there is no data frame pending for the requesting device, the * coordinator shall send a data frame without requesting acknowledgment * to the device containing a zero length payload, indicating that no data * are present, using one of the mechanisms described in this subclause. * [1] pg. 43 */ /* Allocate an IOB to put the frame in */ iob = iob_alloc(false, IOBUSER_WIRELESS_MAC802154); DEBUGASSERT(iob != NULL); iob->io_flink = NULL; iob->io_len = 0; iob->io_offset = 0; iob->io_pktlen = 0; iob->io_len += 2; /* Cast the first two bytes of the IOB to a uint16_t frame control field */ frame_ctrl = (FAR uint16_t *)&iob->io_data[0]; /* Ensure we start with a clear frame control field */ *frame_ctrl = 0; /* Set the frame type to Data */ *frame_ctrl |= IEEE802154_FRAME_DATA << IEEE802154_FRAMECTRL_SHIFT_FTYPE; /* Each time a data or a MAC command frame is generated, the MAC sublayer * shall copy the value of macDSN into the Sequence Number field of the MHR * of the outgoing frame and then increment it by one. [1] pg. 40. */ iob->io_data[iob->io_len++] = priv->dsn++; /* Use the source address information from the received data request to * respond. */ mac802154_putpanid(iob, ind->src.panid); if (ind->src.mode == IEEE802154_ADDRMODE_SHORT) { mac802154_putsaddr(iob, ind->src.saddr); } else if (ind->src.mode == IEEE802154_ADDRMODE_EXTENDED) { mac802154_puteaddr(iob, ind->src.eaddr); } else { DEBUGASSERT(false); } /* Set the destination addr mode inside the frame control field */ *frame_ctrl |= (ind->src.mode << IEEE802154_FRAMECTRL_SHIFT_DADDR); /* Check the source PAN ID of the incoming request is the same as ours. */ if (IEEE802154_PANIDCMP(ind->src.panid, priv->addr.panid)) { *frame_ctrl |= IEEE802154_FRAMECTRL_PANIDCOMP; } else { /* Copy in our PAN ID */ mac802154_putpanid(iob, priv->addr.panid); } /* Copy in our address using the mode that the device used to address us */ if (ind->dest.mode == IEEE802154_ADDRMODE_SHORT) { mac802154_putsaddr(iob, priv->addr.saddr); *frame_ctrl |= (IEEE802154_ADDRMODE_SHORT << IEEE802154_FRAMECTRL_SHIFT_SADDR); } else { mac802154_puteaddr(iob, priv->addr.eaddr); *frame_ctrl |= (IEEE802154_ADDRMODE_EXTENDED << IEEE802154_FRAMECTRL_SHIFT_SADDR); } /* Allocate the txdesc, waiting if necessary, allow interruptions */ mac802154_txdesc_alloc(priv, &txdesc, false); txdesc->frame = iob; txdesc->frametype = IEEE802154_FRAME_DATA; txdesc->ackreq = false; mac802154_unlock(priv) priv->radio->txdelayed(priv->radio, txdesc, 0); } /**************************************************************************** * Name: mac802154_edresult * * Description: * Called from the radio driver through the callback struct. This function * is called when the radio has finished an energy detect operation. This * is triggered by a SCAN.request primitive with ScanType set to Energy * Detect (ED) * ****************************************************************************/ static void mac802154_edresult(FAR const struct ieee802154_radiocb_s *radiocb, uint8_t edval) { FAR struct mac802154_radiocb_s *cb = (FAR struct mac802154_radiocb_s *)radiocb; FAR struct ieee802154_privmac_s *priv; DEBUGASSERT(cb != NULL && cb->priv != NULL); priv = cb->priv; /* Get exclusive access to the driver structure. We don't care about any * signals so if we see one, just go back to trying to get access again. */ mac802154_lock(priv, false); /* If we are actively performing a scan operation, notify the handler */ if (priv->curr_op == MAC802154_OP_SCAN) { mac802154_edscan_onresult(priv, edval); } /* Relinquish control of the private structure */ mac802154_unlock(priv); } static void mac802154_sfevent(FAR const struct ieee802154_radiocb_s *radiocb, enum ieee802154_sfevent_e sfevent) { FAR struct mac802154_radiocb_s *cb = (FAR struct mac802154_radiocb_s *)radiocb; FAR struct ieee802154_privmac_s *priv; DEBUGASSERT(cb != NULL && cb->priv != NULL); priv = cb->priv; /* Get exclusive access to the driver structure. We don't care about any * signals so if we see one, just go back to trying to get access again. */ mac802154_lock(priv, false); switch (sfevent) { case IEEE802154_SFEVENT_ENDOFACTIVE: { #ifdef CONFIG_MAC802154_SFEVENT_VERBOSE wlinfo("End of superframe\n"); #endif /* Check if there is any reason to update the beacon */ if (priv->beaconupdate) { mac802154_updatebeacon(priv); priv->radio->beaconupdate(priv->radio, &priv->beaconframe[priv->bf_ind]); } } break; default: break; } mac802154_unlock(priv) } /**************************************************************************** * Name: mac802154_rxbeaconframe * * Description: * Function called from the generic RX Frame worker to parse and handle the * reception of a beacon frame. * * Assumptions: MAC is unlocked * ****************************************************************************/ static void mac802154_rxbeaconframe(FAR struct ieee802154_privmac_s *priv, FAR struct ieee802154_data_ind_s *ind) { FAR struct ieee802154_txdesc_s *respdesc; FAR struct ieee802154_primitive_s *primitive; FAR struct ieee802154_beacon_ind_s *beacon; FAR struct iob_s *iob = ind->frame; uint8_t ngtsdesc; uint8_t gtsdirmask; bool pending_saddr = false; bool pending_eaddr = false; int i; /* Even though we may not use the primitive, we allocate one to hold all * the parsed beacon information. Freeing the primitive is quick, so it's * worth saving a copy (If you were to parse all the info in locally, you * would have to copy the data over in the case that you actually need to * notify the next highest layer) */ primitive = ieee802154_primitive_allocate(); beacon = &primitive->u.beaconind; /* Make sure there is another 2 bytes to process */ if (iob->io_len < iob->io_offset + 2) { goto errout; } /* Copy the coordinator address and channel info into the pan descriptor */ memcpy(&beacon->pandesc.coordaddr, &ind->src, sizeof(struct ieee802154_addr_s)); beacon->pandesc.chan = priv->currscan.channels[priv->scanindex]; beacon->pandesc.chpage = priv->currscan.chpage; beacon->pandesc.lqi = ind->lqi; beacon->pandesc.timestamp = ind->timestamp; /* Parse the superframe specification field */ beacon->pandesc.sfspec.beaconorder = IEEE802154_GETBEACONORDER(iob->io_data, iob->io_offset); beacon->pandesc.sfspec.sforder = IEEE802154_GETSFORDER(iob->io_data, iob->io_offset); beacon->pandesc.sfspec.final_capslot = IEEE802154_GETFINCAPSLOT(iob->io_data, iob->io_offset); beacon->pandesc.sfspec.ble = IEEE802154_GETBLE(iob->io_data, iob->io_offset); beacon->pandesc.sfspec.pancoord = IEEE802154_GETPANCOORD(iob->io_data, iob->io_offset); beacon->pandesc.sfspec.assocpermit = IEEE802154_GETASSOCPERMIT(iob->io_data, iob->io_offset); iob->io_offset += 2; /* Make sure there is another byte to process (GTS Spec) */ if (iob->io_len < iob->io_offset + 1) { goto errout; } /* Parse the GTS Specification field */ ngtsdesc = IEEE802154_GETGTSDESCCOUNT(iob->io_data, iob->io_offset); beacon->pandesc.gtspermit = IEEE802154_GETGTSPERMIT(iob->io_data, iob->io_offset); iob->io_offset++; /* If there are any GTS descriptors, handle the GTS Dir and List fields */ if (ngtsdesc > 0) { /* Make sure there is another bytes to process (GTS Direction) */ if (iob->io_len < iob->io_offset + 1) { goto errout; } gtsdirmask = IEEE802154_GETGTSDIRMASK(iob->io_data, iob->io_offset); UNUSED(gtsdirmask); iob->io_offset++; /* Make sure there are enough bytes left to represent the GTS List */ if (iob->io_len < iob->io_offset + (3 * ngtsdesc)) { goto errout; } for (i = 0; i < ngtsdesc; i++) { /* For now we just discard the data by skipping over it */ iob->io_offset += 3; } } /* Pending address fields. Min 1 byte, the Pending Address Specification */ if (iob->io_len < iob->io_offset + 1) { goto errout; } beacon->pendaddr.nsaddr = IEEE802154_GETNPENDSADDR(iob->io_data, iob->io_offset); beacon->pendaddr.neaddr = IEEE802154_GETNPENDEADDR(iob->io_data, iob->io_offset); iob->io_offset++; /* Make sure there are enough bytes left to represent the address list */ if (iob->io_len < (iob->io_offset + (IEEE802154_SADDRSIZE * beacon->pendaddr.nsaddr) + (IEEE802154_EADDRSIZE * beacon->pendaddr.neaddr))) { goto errout; } /* Copy in the pending addresses */ for (i = 0; i < beacon->pendaddr.nsaddr; i++) { beacon->pendaddr.addr[i].mode = IEEE802154_ADDRMODE_SHORT; mac802154_takesaddr(iob, beacon->pendaddr.addr[i].saddr); /* Check if the short address matches our short address */ if (IEEE802154_SADDRCMP(beacon->pendaddr.addr[i].saddr, priv->addr.saddr)) { /* Wait to actually decide how to handle this until we parse * the rest of the frame */ wlinfo("Data pending for us in coord\n"); pending_saddr = true; } } for (i = beacon->pendaddr.nsaddr; i < (beacon->pendaddr.nsaddr + beacon->pendaddr.neaddr); i++) { beacon->pendaddr.addr[i].mode = IEEE802154_ADDRMODE_EXTENDED; mac802154_takeeaddr(iob, beacon->pendaddr.addr[i].eaddr); /* If the extended address matches our extended address */ if (IEEE802154_EADDRCMP(beacon->pendaddr.addr[i].eaddr, priv->addr.eaddr)) { /* Wait to actually decide how to handle this until we parse * the rest of the frame */ wlinfo("Data pending for us in coord\n"); pending_eaddr = true; } } /* If there is anything left, process it as the beacon payload */ beacon->payloadlength = iob->io_len - iob->io_offset; if (beacon->payloadlength > 0) { memcpy(beacon->payload, &iob->io_data[iob->io_offset], beacon->payloadlength); } /* At this point, all relevant info is extracted from the incoming frame */ mac802154_lock(priv, false); if (priv->curr_op == MAC802154_OP_SCAN) { /* Check to see if we already have a frame from this coordinator */ for (i = 0; i < priv->npandesc; i++) { if (priv->currscan.channels[priv->scanindex] != priv->pandescs[i].chan) { continue; } if (memcmp(&ind->src, &priv->pandescs[i].coordaddr, sizeof(struct ieee802154_addr_s)) != 0) { continue; } /* The beacon is the same as another, so discard it */ ieee802154_primitive_free(primitive); mac802154_unlock(priv); return; } /* TODO: There is supposed to be different logic for the scanning * procedure based on the macAutoRequest attribute. Currently, we * perform scan operations as if macAutoRequest is set to TRUE, * without actually checking the value. Basically, if macAutoRequest * is TRUE, we are supposed to round up all of the pandesc results and * pass them all up via the SCAN.confirm primitive. If macAutoRequest * is FALSE, we are supposed to notify the next highest layer each * time a unique beacon is received via the BEACON.notify primitive, * and pass a NULLed out list of pandesc when SCAN.confirm is sent. */ /* Copy the pan desc to the list of pan desc */ memcpy(&priv->pandescs[priv->npandesc], &beacon->pandesc, sizeof(struct ieee802154_pandesc_s)); priv->npandesc++; if (priv->npandesc == MAC802154_NPANDESC) { mac802154_scanfinish(priv, IEEE802154_STATUS_LIMITREACHED); } } /* If we are not performing a SCAN operation */ else { /* Check superframe structure and update the appropriate attributes. */ if (memcmp(&priv->sfspec, &beacon->pandesc.sfspec, sizeof(struct ieee802154_superframespec_s)) != 0) { /* Copy in the new superframe spec */ memcpy(&priv->sfspec, &beacon->pandesc.sfspec, sizeof(struct ieee802154_superframespec_s)); /* Tell the radio layer about the superframe spec update */ priv->radio->sfupdate(priv->radio, &priv->sfspec); } /* If we are performing an association and there is data pending for us * we ignore the autoRequest logic and just extract it. We also don't * send a BEACON-NOTFIY.indication in this case, not sure if that is * the right thing to do, can't find anything definitive in standard. */ if (priv->curr_op == MAC802154_OP_ASSOC && pending_eaddr) { priv->curr_cmd = IEEE802154_CMD_DATA_REQ; mac802154_txdesc_alloc(priv, &respdesc, false); mac802154_createdatareq(priv, &priv->pandesc.coordaddr, IEEE802154_ADDRMODE_EXTENDED, respdesc); /* Link the transaction into the CSMA transaction list */ sq_addlast((FAR sq_entry_t *)respdesc, &priv->csma_queue); /* Notify the radio driver that there is data available */ priv->radio->txnotify(priv->radio, false); } else { if (priv->autoreq || priv->curr_op == MAC802154_OP_POLL) { /* If a beacon frame is received and macAutoRequest is set to * TRUE, the MLME shall first issue the MLME- * BEACON-NOTIFY.indication primitive if the beacon contains * any payload. */ if (beacon->payloadlength > 0) { mac802154_notify(priv, primitive); } /* If we have data pending for us, attempt to extract it. If * for some reason we have data pending under our short * address and our extended address, let the short address * arbitrarily take precedence */ if (pending_saddr | pending_eaddr) { mac802154_txdesc_alloc(priv, &respdesc, false); if (priv->curr_op == MAC802154_OP_POLL) { priv->curr_cmd = IEEE802154_CMD_DATA_REQ; } else if (priv->curr_op == MAC802154_OP_ASSOC) { priv->curr_cmd = IEEE802154_CMD_DATA_REQ; } else if (priv->curr_op == MAC802154_OP_NONE) { DEBUGASSERT(priv->opsem.semcount == 1); mac802154_takesem(&priv->opsem, false); priv->curr_op = MAC802154_OP_AUTOEXTRACT; priv->curr_cmd = IEEE802154_CMD_DATA_REQ; } if (pending_saddr) { mac802154_createdatareq(priv, &priv->pandesc.coordaddr, IEEE802154_ADDRMODE_SHORT, respdesc); } else { mac802154_createdatareq(priv, &priv->pandesc.coordaddr, IEEE802154_ADDRMODE_EXTENDED, respdesc); } /* Link the transaction into the CSMA transaction list */ sq_addlast((FAR sq_entry_t *)respdesc, &priv->csma_queue); /* Notify the radio driver that there is data available */ priv->radio->txnotify(priv->radio, false); } /* If there was a beacon payload, we used the primitive, so * return here to make sure we don't free the primitive. */ if (beacon->payloadlength > 0) { mac802154_unlock(priv); return; } } else { /* If a valid beacon frame is received and macAutoRequest is * set to FALSE, the MLME shall indicate the beacon parameters * to the next higher layer by issuing the * MLME-BEACON-NOTIFY.indication primitive. [1] pg. 38 */ mac802154_notify(priv, primitive); mac802154_unlock(priv); return; /* Return so that we don't free the primitive */ } } } mac802154_unlock(priv); ieee802154_primitive_free(primitive); return; errout: wlwarn("Received beacon with bad format\n"); ieee802154_primitive_free(primitive); } /**************************************************************************** * Public Functions ****************************************************************************/ /**************************************************************************** * Name: mac802154_create * * Description: * Create a 802.15.4 MAC device from a 802.15.4 compatible radio device. * * The returned MAC structure should be passed to either the next highest * layer in the network stack, or registered with a mac802154dev character * or network drivers. In any of these scenarios, the next highest layer * should register a set of callbacks with the MAC layer by setting the * mac->cbs member. * * NOTE: This API does not create any device accessible to userspace. If * you want to call these APIs from userspace, you have to wrap your mac * in a character device via mac802154_device.c. * * Input Parameters: * radiodev - an instance of an IEEE 802.15.4 radio * * Returned Value: * An opaque reference to the MAC state data. * ****************************************************************************/ MACHANDLE mac802154_create(FAR struct ieee802154_radio_s *radiodev) { FAR struct ieee802154_privmac_s *mac; FAR struct ieee802154_radiocb_s *radiocb; /* Allocate object */ mac = (FAR struct ieee802154_privmac_s *) kmm_zalloc(sizeof(struct ieee802154_privmac_s)); if (mac == NULL) { wlinfo("Failed allocation privmac structure\n"); return NULL; } /* Allow exclusive access to the privmac struct */ nxsem_init(&mac->exclsem, 0, 1); /* Allow exclusive access to the dedicated command transaction */ nxsem_init(&mac->opsem, 0, 1); /* Initialize fields */ mac->radio = radiodev; /* Initialize the Radio callbacks */ mac->radiocb.priv = mac; radiocb = &mac->radiocb.cb; radiocb->poll = mac802154_radiopoll; radiocb->txdone = mac802154_txdone; radiocb->rxframe = mac802154_rxframe; radiocb->sfevent = mac802154_sfevent; radiocb->edresult = mac802154_edresult; /* Bind our callback structure */ radiodev->bind(radiodev, &mac->radiocb.cb); /* Initialize our various data pools */ ieee802154_primitivepool_initialize(); mac802154_resetqueues(mac); mac802154_req_reset((MACHANDLE)mac, true); return (MACHANDLE)mac; }